From a10898b662d3cd24d6421ea9b5580658f452dcb3 Mon Sep 17 00:00:00 2001 From: Owen Taylor Date: Sat, 3 Mar 2001 23:29:50 +0000 Subject: [PATCH] You can't use + as a metacharacter for basic regular expressions. (This Sat Mar 3 17:20:53 2001 Owen Taylor * */Makefile.am (scan-build.stamp): You can't use + as a metacharacter for basic regular expressions. (This was the "all objects disappear") * gdk/gdk-sections.txt gdk-pixbuf/gdk-pixbuf-sections.txt * */*-unused.sgml: Remove a lot of empty stuff. (No point in saving old docs when there aren't any.) --- docs/reference/ChangeLog | 11 + docs/reference/gdk-pixbuf/Makefile.am | 2 +- .../gdk-pixbuf/gdk-pixbuf-sections.txt | 4 +- .../gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml | 208 - .../gdk-pixbuf/tmpl/module_interface.sgml | 8 + docs/reference/gdk/Makefile.am | 2 +- docs/reference/gdk/gdk-sections.txt | 12 + docs/reference/gdk/tmpl/event_structs.sgml | 21 + docs/reference/gdk/tmpl/events.sgml | 1 + docs/reference/gdk/tmpl/gdk-unused.sgml | 347 -- .../reference/gdk/tmpl/pango_interaction.sgml | 2 +- docs/reference/gdk/tmpl/regions.sgml | 47 +- docs/reference/gdk/tmpl/rgb.sgml | 1 + docs/reference/gdk/tmpl/windows.sgml | 69 + docs/reference/gdk/tmpl/x_interaction.sgml | 9 + docs/reference/gtk/Makefile.am | 2 +- docs/reference/gtk/tmpl/gtk-unused.sgml | 5243 ++--------------- docs/reference/gtk/tmpl/gtkcellrenderer.sgml | 1 + docs/reference/gtk/tmpl/gtkcombo.sgml | 15 + docs/reference/gtk/tmpl/gtkentry.sgml | 5 + docs/reference/gtk/tmpl/gtkenums.sgml | 8 + docs/reference/gtk/tmpl/gtkrange.sgml | 128 - docs/reference/gtk/tmpl/gtksignal.sgml | 7 - docs/reference/gtk/tmpl/gtktextbuffer.sgml | 27 +- docs/reference/gtk/tmpl/gtktextiter.sgml | 9 - docs/reference/gtk/tmpl/gtktexttag.sgml | 10 - .../gtk/tmpl/gtktreemodelsimple.sgml | 56 - docs/reference/gtk/tmpl/gtktreeselection.sgml | 1 + docs/reference/gtk/tmpl/gtktreestore.sgml | 10 - .../reference/gtk/tmpl/gtktreeviewcolumn.sgml | 23 +- docs/reference/gtk/tmpl/gtktypeutils.sgml | 1 + docs/reference/gtk/tmpl/gtkwidget.sgml | 39 +- 32 files changed, 862 insertions(+), 5467 deletions(-) diff --git a/docs/reference/ChangeLog b/docs/reference/ChangeLog index 82615e1ded..6a8a9e096f 100644 --- a/docs/reference/ChangeLog +++ b/docs/reference/ChangeLog @@ -1,3 +1,14 @@ +Sat Mar 3 17:20:53 2001 Owen Taylor + + * */Makefile.am (scan-build.stamp): You can't use + + as a metacharacter for basic regular expressions. + (This was the "all objects disappear") + + * gdk/gdk-sections.txt gdk-pixbuf/gdk-pixbuf-sections.txt + + * */*-unused.sgml: Remove a lot of empty stuff. (No + point in saving old docs when there aren't any.) + 2001-02-20 Havoc Pennington * gdk/tmpl/rgb.sgml: fix these docs to reflect the current state diff --git a/docs/reference/gdk-pixbuf/Makefile.am b/docs/reference/gdk-pixbuf/Makefile.am index 1afdcd2970..4f6d32d06a 100644 --- a/docs/reference/gdk-pixbuf/Makefile.am +++ b/docs/reference/gdk-pixbuf/Makefile.am @@ -94,7 +94,7 @@ SCANOBJ_FILES = \ scan-build.stamp: $(HFILE_GLOB) @echo '*** Scanning header files ***' cd $(srcdir) && ( \ - if grep -l '^.+$$' $(DOC_MODULE).types > /dev/null ; then \ + if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null ; then \ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) ; \ else \ for i in $(SCANOBJ_FILES) ; do \ diff --git a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt index 3bb6f13189..84ad937450 100644 --- a/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt +++ b/docs/reference/gdk-pixbuf/gdk-pixbuf-sections.txt @@ -138,14 +138,12 @@ gdk_pixbuf_loader_get_type
Module Interface module_interface +ModuleFillVtableFunc ModulePreparedNotifyFunc ModuleUpdatedNotifyFunc ModuleFrameDoneNotifyFunc ModuleAnimationDoneNotifyFunc GdkPixbufModule -_gdk_pixbuf_get_module -_gdk_pixbuf_get_named_module -_gdk_pixbuf_load_module
diff --git a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml index a13ef4e4a9..910ccef35f 100644 --- a/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/gdk-pixbuf-unused.sgml @@ -22,26 +22,6 @@ Getting parts of a drawable's image data into a pixbuf. Drawables to Pixbufs - - - - - - - - - - - - - - - - - -gdk-pixbuf-io - - This canvas item displays #GdkPixbuf images. It handles full @@ -385,18 +365,6 @@ XlibRGB @obj: A GTK+ object. - - - - - - - - - - - - A function of this type can be used to override the default @@ -584,179 +552,3 @@ End: - - - - - -@pixbuf: - - - - - - -@pixbuf: -@Returns: - - - - - - -@dest: -@src: -@cmap: -@src_x: -@src_y: -@dest_x: -@dest_y: -@width: -@height: -@Returns: - - - - - - -@buffer: -@size: -@filename: -@error: -@Returns: - - - - - - -@name: -@error: -@Returns: - - - - - - - - - - - - -@image_module: -@error: -@Returns: - - - - - - -@art_pixbuf: -@Returns: - - - - - - -@app: -@modinfo: - - - - - - -@app: -@modinfo: - - - - - - -@pixbuf: -@pixmap_return: -@mask_return: -@alpha_threshold: - - - - - - -@pixbuf: -@bitmap: -@src_x: -@src_y: -@dest_x: -@dest_y: -@width: -@height: -@alpha_threshold: - - - - - - -@pixbuf: -@drawable: -@gc: -@src_x: -@src_y: -@dest_x: -@dest_y: -@width: -@height: -@dither: -@x_dither: -@y_dither: - - - - - - -@pixbuf: -@drawable: -@src_x: -@src_y: -@dest_x: -@dest_y: -@width: -@height: -@alpha_mode: -@alpha_threshold: -@dither: -@x_dither: -@y_dither: - - - - - - -@pixbuf: -@last_unref_fn: -@last_unref_fn_data: - diff --git a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml index 9b42714311..563fabb57e 100644 --- a/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml +++ b/docs/reference/gdk-pixbuf/tmpl/module_interface.sgml @@ -14,6 +14,14 @@ Module Interface + + + + + +@module: + + diff --git a/docs/reference/gdk/Makefile.am b/docs/reference/gdk/Makefile.am index a264153039..60c8e1e5d8 100644 --- a/docs/reference/gdk/Makefile.am +++ b/docs/reference/gdk/Makefile.am @@ -85,7 +85,7 @@ SCANOBJ_FILES = \ scan-build.stamp: $(HFILE_GLOB) @echo '*** Scanning header files ***' cd $(srcdir) && ( \ - if grep -l '^.+$$' $(DOC_MODULE).types > /dev/null ; then \ + if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null ; then \ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) ; \ else \ for i in $(SCANOBJ_FILES) ; do \ diff --git a/docs/reference/gdk/gdk-sections.txt b/docs/reference/gdk/gdk-sections.txt index 975b105f7d..437fa094fe 100644 --- a/docs/reference/gdk/gdk-sections.txt +++ b/docs/reference/gdk/gdk-sections.txt @@ -392,8 +392,14 @@ gdk_window_show gdk_window_hide gdk_window_is_visible gdk_window_is_viewable +gdk_window_get_state gdk_window_withdraw gdk_window_iconify +gdk_window_deiconify +gdk_window_stick +gdk_window_unstick +gdk_window_maximize +gdk_window_unmaximize gdk_window_move gdk_window_resize gdk_window_move_resize @@ -405,6 +411,7 @@ gdk_window_clear_area_e gdk_window_copy_area gdk_window_raise gdk_window_lower +gdk_window_focus gdk_window_register_dnd @@ -431,6 +438,7 @@ GdkFilterFunc GdkFilterReturn GdkXEvent gdk_window_shape_combine_mask +gdk_window_shape_combine_region gdk_window_set_child_shapes gdk_window_merge_child_shapes gdk_window_set_static_gravities @@ -592,6 +600,7 @@ gdk_region_destroy gdk_region_get_clipbox +gdk_region_get_rectangles gdk_region_empty gdk_region_equal gdk_region_point_in @@ -751,6 +760,7 @@ GdkEventDND GdkEventProximity GdkEventClient GdkEventNoExpose +GdkEventWindowState GdkScrollDirection @@ -758,6 +768,7 @@ GdkVisibilityState GdkCrossingMode GdkNotifyType GdkPropertyState +GdkWindowState
@@ -856,6 +867,7 @@ gdk_window_lookup gdk_pixmap_lookup gdk_font_lookup gdk_x11_get_server_time +gdk_net_wm_supports GDK_TYPE_GC_X11 diff --git a/docs/reference/gdk/tmpl/event_structs.sgml b/docs/reference/gdk/tmpl/event_structs.sgml index a6d41967cb..98f0b6afb9 100644 --- a/docs/reference/gdk/tmpl/event_structs.sgml +++ b/docs/reference/gdk/tmpl/event_structs.sgml @@ -344,6 +344,17 @@ FIXME: add more here. @window: the window which received the event. @send_event: TRUE if the event was sent explicitly (e.g. using XSendEvent). + + + + + +@type: +@window: +@send_event: +@changed_mask: +@new_window_state: + @@ -392,3 +403,13 @@ Specifies the type of a property change for a #GdkEventProperty. @GDK_PROPERTY_NEW_VALUE: the property value wan changed. @GDK_PROPERTY_DELETE: the property was deleted. + + + + + +@GDK_WINDOW_STATE_WITHDRAWN: +@GDK_WINDOW_STATE_ICONIFIED: +@GDK_WINDOW_STATE_MAXIMIZED: +@GDK_WINDOW_STATE_STICKY: + diff --git a/docs/reference/gdk/tmpl/events.sgml b/docs/reference/gdk/tmpl/events.sgml index 117f6f8ce4..9e2edc7d80 100644 --- a/docs/reference/gdk/tmpl/events.sgml +++ b/docs/reference/gdk/tmpl/events.sgml @@ -82,6 +82,7 @@ has changed. @GDK_NO_EXPOSE: indicates that the source region was completely available when parts of a drawable were copied. This is not very useful. @GDK_SCROLL: +@GDK_WINDOW_STATE: diff --git a/docs/reference/gdk/tmpl/gdk-unused.sgml b/docs/reference/gdk/tmpl/gdk-unused.sgml index 0f2eda516c..5a2f9d9543 100644 --- a/docs/reference/gdk/tmpl/gdk-unused.sgml +++ b/docs/reference/gdk/tmpl/gdk-unused.sgml @@ -1,122 +1,3 @@ - - -The #GdkColorContext type is used for allocating groups of colors. - - -It is now deprecated in favor of the gdk_colormap_*() functions described in -the Colormaps and Colors -section. - - - - - - - - - - -routines for allocating colors (deprecated). - - - -Color Contexts - - - - - - - - - - - - - - - - - - - -Keyboard Handling - - - - - - - - - - - - - - - - - - - -Points, Rectangles and Regions - - - - - - - - - - - - - - - - - - - -Pango Interaction - - - - -GDK provides the #GdkPoint, #GdkRectangle and #GdkRegion data types for -representing pixels and sets of pixels on the screen. - - -#GdkPoint is a simple structure containing an x and y coordinate of a point. - - -#GdkRectangle is a structure holding the position and size of a rectangle. -The intersection of two rectangles can be computed with -gdk_rectangle_intersect(). To find the union of two rectangles use -gdk_rectangle_union(). - - -#GdkRegion is an opaque data type holding a set of arbitrary pixels, and is -usually used for clipping graphical operations (see gdk_gc_set_clip_region()). - - - - - - - - - - -simple graphical data types. - - - -Points, Rectangles and Regions - - This macro contains an integer value representing @@ -124,48 +5,6 @@ the device ID for the core pointer device. - - - - - -@visual: -@colormap: -@num_colors: -@max_colors: -@num_allocated: -@mode: -@need_to_free_colormap: -@std_cmap_atom: -@clut: -@cmap: -@color_hash: -@palette: -@num_palette: -@fast_dither: - - - - - - -@fast_rgb: -@fast_err: -@fast_erg: -@fast_erb: - - - - - - -@GDK_CC_MODE_UNDEFINED: -@GDK_CC_MODE_BW: -@GDK_CC_MODE_STD_CMAP: -@GDK_CC_MODE_TRUE: -@GDK_CC_MODE_MY_GRAY: -@GDK_CC_MODE_PALETTE: - The #GdkDeviceInfo structure contains information about a @@ -198,137 +37,6 @@ device. It has the following fields: @GDK_PIXBUF_ALPHA_BILEVEL: @GDK_PIXBUF_ALPHA_FULL: - - - - - -@cc: -@palette: -@num_palette: -@Returns: - - - - - - -@cc: - - - - - - -@cc: - - - - - - -@cc: -@red: -@green: -@blue: -@failed: -@Returns: - - - - - - -@cc: -@red: -@green: -@blue: -@failed: -@Returns: - - - - - - -@cc: -@red: -@green: -@blue: -@failed: -@Returns: - - - - - - -@cc: -@reds: -@greens: -@blues: -@ncolors: -@colors: -@nallocated: - - - - - - -@cc: -@reds: -@greens: -@blues: -@ncolors: -@used: -@colors: -@nallocated: - - - - - - -@cc: - - - - - - -@visual: -@colormap: -@Returns: - - - - - - -@visual: -@colormap: -@Returns: - - - - - - -@cc: -@color: -@Returns: - - - - - - -@cc: -@colors: -@num_colors: -@Returns: - Lists all available input devices, along with their @@ -411,59 +119,4 @@ they will be ignored. @ytilt: location to store current tilt in the y direction. @mask: location to store the current modifier state. - - -Disables the keyboard auto-repeat mode. -This should be used with care as it may affect other applications. - - - - - -Restores the keyboard auto-repeat mode to its state when the application was -started. - - - - - -Returns the intersection of two regions. - - -@source1: a #GdkRegion. -@source2: a #GdkRegion. -@Returns: the intersection of @source1 and @source2. - - - -Subtracts one region from another. -The result is a region containing all the pixels which are in @source1, but -which are not in @source2. - - -@source1: a #GdkRegion. -@source2: a #GdkRegion to subtract from @source1. -@Returns: @source1 - @source2. - - - -Returns the union of two regions. -This is all pixels in either of @source1 or @source2. - - -@source1: a #GdkRegion. -@source2: a #GdkRegion. -@Returns: the union of @source1 and @source2. - - - -Returns the difference between the union and the intersection of two regions. -This is a region containing the pixels that are in one of the source regions, -but which are not in both. - - -@source1: a #GdkRegion. -@source2: a #GdkRegion. -@Returns: the difference between the union and the intersection of @source1 -and @source2. diff --git a/docs/reference/gdk/tmpl/pango_interaction.sgml b/docs/reference/gdk/tmpl/pango_interaction.sgml index ffd0fda549..8ecda464a8 100644 --- a/docs/reference/gdk/tmpl/pango_interaction.sgml +++ b/docs/reference/gdk/tmpl/pango_interaction.sgml @@ -61,7 +61,7 @@ Pango Interaction -@bitmap: +@stipple: @Returns: diff --git a/docs/reference/gdk/tmpl/regions.sgml b/docs/reference/gdk/tmpl/regions.sgml index 68f897cc59..77b197f74d 100644 --- a/docs/reference/gdk/tmpl/regions.sgml +++ b/docs/reference/gdk/tmpl/regions.sgml @@ -151,6 +151,16 @@ Returns the smallest rectangle which includes the entire #GdkRegion. @rectangle: returns the smallest rectangle which includes all of @region. + + + + + +@region: +@rectangles: +@n_rectangles: + + Returns TRUE if the #GdkRegion is empty. @@ -225,49 +235,58 @@ Positive values shrink the region. Negative values expand it. -Returns the union of a region and a rectangle. +Sets the area of @region to the union of the areas of @region and +@rect. The resulting area is the set of pixels contained in +either @region or @rect. + @region: a #GdkRegion. @rect: a #GdkRectangle. - -@Returns: the union of @region and @rect. - +Sets the area of @source1 to the intersection of the areas of @source1 +and @source2. The resulting area is the set of pixels contained in +both @source1 and @source2. -@source1: -@source2: +@source1: a #GdkRegion +@source2: a #GdkRegion +Sets the area of @source1 to the union of the areas of @source1 and +@source2. The resulting area is the set of pixels contained in +either @source1 or @source2. -@source1: -@source2: +@source1: a #GdkRegion +@source2: a #GdkRegion - +Subtracts the area of @source2 from the area @source1. The resulting +area is the set of pixels contained in @source1 but not in @source2. -@source1: -@source2: +@source1: a #GdkRegion +@source2: a #GdkRegion - +Sets the area of @source1 to the exclusive-OR of the areas of @source1 +and @source2. The resulting area is the set of pixels contained in one +or the other of the two sources but not in both. -@source1: -@source2: +@source1: a #GdkRegion +@source2: a #GdkRegion diff --git a/docs/reference/gdk/tmpl/rgb.sgml b/docs/reference/gdk/tmpl/rgb.sgml index a62e96e842..f7c8d5b91d 100644 --- a/docs/reference/gdk/tmpl/rgb.sgml +++ b/docs/reference/gdk/tmpl/rgb.sgml @@ -119,6 +119,7 @@ This function no longer does anything at all. It's completely useless + Draws an RGB image in the drawable. This is the core GdkRgb diff --git a/docs/reference/gdk/tmpl/windows.sgml b/docs/reference/gdk/tmpl/windows.sgml index ab6096ba29..a28540f9ed 100644 --- a/docs/reference/gdk/tmpl/windows.sgml +++ b/docs/reference/gdk/tmpl/windows.sgml @@ -212,6 +212,15 @@ Windows @Returns: + + + + + +@window: +@Returns: + + @@ -228,6 +237,46 @@ Windows @window: + + + + + +@window: + + + + + + + +@window: + + + + + + + +@window: + + + + + + + +@window: + + + + + + + +@window: + + @@ -348,6 +397,15 @@ Windows @window: + + + + + +@window: +@timestamp: + + @@ -526,6 +584,17 @@ Windows @offset_y: + + + + + +@window: +@shape_region: +@offset_x: +@offset_y: + + diff --git a/docs/reference/gdk/tmpl/x_interaction.sgml b/docs/reference/gdk/tmpl/x_interaction.sgml index 740f3911cd..710277fbcc 100644 --- a/docs/reference/gdk/tmpl/x_interaction.sgml +++ b/docs/reference/gdk/tmpl/x_interaction.sgml @@ -304,3 +304,12 @@ X Window System Interaction @Returns: + + + + + +@property: +@Returns: + + diff --git a/docs/reference/gtk/Makefile.am b/docs/reference/gtk/Makefile.am index 8e73da65a2..1a32ae5495 100644 --- a/docs/reference/gtk/Makefile.am +++ b/docs/reference/gtk/Makefile.am @@ -121,7 +121,7 @@ SCANOBJ_FILES = \ scan-build.stamp: $(HFILE_GLOB) @echo '*** Scanning header files ***' cd $(srcdir) && ( \ - if grep -l '^.+$$' $(DOC_MODULE).types > /dev/null ; then \ + if grep -l '^..*$$' $(DOC_MODULE).types > /dev/null ; then \ CC="$(GTKDOC_CC)" LD="$(GTKDOC_LD)" CFLAGS="$(GTKDOC_CFLAGS)" LDFLAGS="$(GTKDOC_LIBS)" gtkdoc-scangobj --module=$(DOC_MODULE) ; \ else \ for i in $(SCANOBJ_FILES) ; do \ diff --git a/docs/reference/gtk/tmpl/gtk-unused.sgml b/docs/reference/gtk/tmpl/gtk-unused.sgml index 88a292bb43..e3fb5dcbae 100644 --- a/docs/reference/gtk/tmpl/gtk-unused.sgml +++ b/docs/reference/gtk/tmpl/gtk-unused.sgml @@ -1,4899 +1,1032 @@ - - - - - - - - - - - + +Debugging - + +gtkenums.sgml - -Keyboard Accelerators + +GtkIMContextSimple - + + +What are Signal Marshallers? -All the functions in here are marked a Non-public. -We describe it anyway because it is occasionally useful -to understand how the work is done. +Marshals are functions which all have the same prototype: +they take a #GtkObject, a #GtkSignalFunc, a #gpointer, +and an array of argument values. +The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2.... -Arguments are a way of describing a named parameter to a function. -They have two important roles within gtk+: - - - -they describe object properties. -This means that they present an interface to get and set a named-type -for any type of object in a consistent way. -(All the relevant functions to do this start with gtk_object_set -or gtk_object_get). +They then call a native function: the GtkObject is the first +parameter passed in. The arguments are passed in the native +calling convention: chars, shorts, ints, longs may be packed +on the stack, or tucked in registers: it doesn't matter +because the same calling convention will be generated +inside the gtkmarshal code as is expected where you define +your handlers. - - -they describe signal arguments. -This is a lot less often needed but still useful. -Usually if you are just emitting or creating a particular signal -it is more convenient to just use gtk_signal_emit() or gtk_signal_new(). -However if you are writing a function to emit or create an arbitrary -signal, you must use gtk_signal_emitv() or gtk_signal_newv(). - - - +So the function named: + +gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*); + +will call the #GtkSignalFunc assuming it was a function with signature: + +gboolean sigfunc(gpointer,gint,gint,guint); + - - - + + +Writing Custom Marshals -#GtkObject. +Marshals are primarily used as arguments to gtk_signal_new(). +Sometimes, you may find that a marshaller you need isn't available +in the standard list. Then you have to write your own. - - - -Utility function to manipulate lists of named, typed arguments. - - - -Implementation of Object Properties - - - +If you wish to define a signal with a new type of argument list. +Suppose you want 2 pointers and 2 integers. +You would write: + +typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)( + gpointer, gpointer, gint, gint +); +void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, + GtkSignalFunc func, + gpointer func_data, + GtkArg* args) +{ + GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc; + gint* return_val; + return_val = GTK_RETLOC_INT(args[4]); + rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func; + *return_val = (*rfunc)(object, + GTK_VALUE_POINTER(args[0]), + GTK_VALUE_POINTER(args[1]), + GTK_VALUE_INT(args[2]), + GTK_VALUE_INT(args[3]), + func_data); +} + + - + + - - + +#GtkSignal +The signal handling functions (of which marshallers are +really an implementation detail). + - + + + +Functions to adapt C structures to native calling convention. - -Bindings + +Signal Marshallers - - - + +Private Information - + - +A macro to check whether a child widget of the CList +has the focus. +@clist: The #GtkCList widget to check. - - - - - -GtkCellRenderer - - - + - +Test whether a GtkObject's arguments have been prepared. +@obj: the object to examine. - + - +Get the number of signals defined by this object. +@obj: the object to query. - - - - - -GtkCellRendererPixbuf - - - + - +Get the array of signals defined for this object. +@obj: the object to fetch the signals from. - + - +A macro that returns a GList that contains the selection of the root tree of @obj. +@obj: A pointer to the #GtkTree. @obj will accept any pointer, but it the pointer does not point to a #GtkTree, the results are undefined. - - - - - -GtkCellRendererText - - - + - +The first "flat" (no struct) enumerated type value. - + - +The last "flat" (no struct) enumerated type value. - - - - - -GtkCellRendererTextPixbuf - - - + - +Hide the name of gtk_identifier_get_type - + - +Combine a fundemantal type and a sequence number to create a gtk type. +@parent_t: +@seqno: - - - - - -GtkCellRendererToggle - - - - - The #GtkClipboard object represents a clipboard of data shared - between different processes or between different widgets in - the same process. Each clipboard is identified by a name encoded as a - #GdkAtom. (Conversion to and from strings can be done with - gdk_atom_intern() and gdk_atom_name().) The default clipboard - corresponds to the CLIPBOARD atom; another commonly used clipboard - is the PRIMARY clipboard, which, in X, traditionally contains - the currently selected text. - - - To support having a number of different formats on the clipboard - at the same time, the clipboard mechanism allows providing - callbacks instead of the actual data. When you set the contents - of the clipboard, you can either supply the data directly (via - functions like gtk_clipboard_set_text()), or you can supply a - callback to be called at a later time when the data is needed (via - gtk_clipboard_set_with_data() or gtk_clipboard_set_with_owner().) - Providing a callback also avoids having to make copies of the data - when it is not needed. - - - gtk_clipboard_set_with_data() and gtk_clipboard_set_with_owner() - are quite similar; the choice between the two depends mostly on - which is more convenient in a particular situation. - The former is most useful when you want to have a blob of data - with callbacks to convert it into the various data types that you - advertise. When the @clear_func you provided is called, you - simply free the data blob. The latter is more useful when the - contents of clipboard reflect the internal state of a @GObject - (As an example, for the PRIMARY clipboard, when an entry widget - provides the clipboard's contents the contents are simply the - text within the selected region.) If the contents change, the - entry widget can call gtk_clipboard_set_with_owner() to update - the timestamp for clipboard ownership, without having to worry - about @clear_func being called. - - - Requesting the data from the clipboard is essentially - asynchronous. If the contents of the clipboard are provided within - the same process, then a direct function call will be made to - retrieve the data, but if they are provided by another process, - then the data needs to be retrieved from the other process, which - may take some time. To avoid blocking the user interface, the call - to request the selection, gtk_clipboard_request_contents() takes a - callback that will be called when the contents are received (or - when the request fails.) If you don't want to deal with providing - a separate callback, you can also use gtk_clipboard_wait_for_contents(). - What this does is run the Glib main loop recursively waiting for - the contents. This can simplify the code flow, but you still have - to be aware that other callbacks in your program can be called - while this recursive mainloop is running. - - - Along with the functions to get the clipboard contents as an - arbitrary data chunk, there are also functions to retrieve - it as text, gtk_clipboard_request_text() and - gtk_clipboard_wait_for_text(). These functions take care of - determining which formats are advertised by the clipboard - provider, asking for the clipboard in the best available format - and converting the results into the UTF-8 encoding. (The standard - form for representing strings in GTK+.) - - - - + - - - -#GtkSelection -@GtkClipboard provides a high-level wrapper around the - lower level routines that deal with X selections. It is - also possibly to directly manipulate the X selections, - though it is seldom necessary to do so. - - - +No idea. - -Storing data on Clipboards. - - - -Clipboards - - - + - +Convert a gtk type into its sequence number +@type: - + - +The first structured enumerated type value. - - - - - -Debugging - - - + -GTK+ has a rich set of functions for doing inter-process -communication via the drag-and-drop metaphore. GTK+ -can do drag and drop (DND) via multiple protocols. -The currently supported protocols are the Xdnd and -Motif protocols. - -As well as the functions listed here, applications -may need to use some facilities provided for -Selections. -Also, the Drag and Drop API makes use of signals -in the #GtkWidget class. +The last structured enumerated type value. - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS +@a: - -Functions for controlling drag and drop handling. - - - -Drag and Drop - - - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK +@a: - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK +@a: - - - - - -gtkenums.sgml - - - + - +Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN +@a: - + - +Indicates that the user has activated the widget +in some fashion. Generally, this will be done +with a keystroke. (The default binding for this +action is Return for #GtkEntry and +Control-Return for #GtkText.) +@editable: the object which received the signal. - -Public enumerated types used throughout GTK+. - - - -Standard Enumerations - - - + -This section describes the variables and functions available to test the -version of the GTK+ library in use. -FIXME: probably merge with other general stuff. +Indicates that the user has changed the contents +of the widget. +@editable: the object which received the signal. - + - +An action signal. Causes the characters in the current selection to +be copied to the clipboard. +@editable: the object which received the signal. - -variables and functions to check the GTK+ version. - - - -Version Information - - - + -These functions provide access to a shared pool of #GdkGC objects. -When a new #GdkGC is needed, gtk_gc_get() is called with the required depth, -colormap and #GdkGCValues. If a #GdkGC with the required properties already -exists then that is returned. If not, a new #GdkGC is created. -When the #GdkGC is no longer needed, gtk_gc_release() is called. +An action signal. Causes the characters in the current +selection to be copied to the clipboard and then deleted from +the widget. +@editable: the object which received the signal. - + - +This signal is emitted when text is deleted from +the widget by the user. The default handler for +this signal will normally be responsible for inserting +the text, so by connecting to this signal and then +stopping the signal with gtk_signal_emit_stop(), it +is possible to modify the inserted text, or prevent +it from being inserted entirely. The @start_pos +and @end_pos parameters are interpreted as for +gtk_editable_delete_text() +@editable: the object which received the signal. +@start_pos: the starting position. +@end_pos: the end position. - -provides access to a shared pool of #GdkGC objects. - - - -Graphics Contexts - - - + - An icon factory manages a collection of #GtkIconSet; a #GtkIconSet manages a - set of variants of a particular icon (i.e. a #GtkIconSet contains variants for - different sizes and widget states). Icons in an icon factory are named by a - stock ID, which is a simple string identifying the icon. Each #GtkStyle has a - list of #GtkIconFactory derived from the current theme; those icon factories - are consulted first when searching for an icon. If the theme doesn't set a - particular icon, GTK+ looks for the icon in a list of default icon factories, - maintained by gtk_icon_factory_add_default() and - gtk_icon_factory_remove_default(). Applications with icons should add a default - icon factory with their icons, which will allow themes to override the icons - for the application. - - - -To display an icon, always use gtk_style_lookup_icon_set() on the widget that -will display the icon, or the convenience function -gtk_widget_render_icon(). These functions take the theme into account when -looking up the icon to use for a given stock ID. - - - - - - - - - - - -Manipulating stock icons - - - -Themeable Stock Images - - - - - - - - - - - - - - - - - - - -GtkIMContextSimple - - - - - - - - - - - - - - - - - - - -GtkListStore - - - - -GTK uses an event oriented programming model. While conventional C programs -have control over the program flow all the time this does not apply to -applications written using GTK. Instead you set up some objects and -register some functions (callbacks) to be called whenever -some event occurs and give control to the GTK mainloop (e.g. by calling -gtk_main). - - - - Typical <function>main</function> function for a GTK application - -int -main (int argc, char **argv) -{ - /* Initialize i18n support */ - gtk_set_locale (); - - /* Initialize the widget set */ - gtk_init (&argc, &argv); - - /* Create the main window */ - mainwin = gtk_window_new (GTK_WINDOW_TOPLEVEL); - - /* Set up our GUI elements */ - ... - - /* Show the application window */ - gtk_widget_showall (mainwin); - - /* Let the user interact with our application */ - gtk_main (); - - /* The user lost interest */ - gtk_exit (0); -} - - - - - - - - - - -Mainloop and event handling - - - -General - - - - -What are Signal Marshallers? - -Marshals are functions which all have the same prototype: -they take a #GtkObject, a #GtkSignalFunc, a #gpointer, -and an array of argument values. -The functions are names gtk_marshall_RETURNTYPE__PARAMTYPE1_PARAMTYPE2.... - - -They then call a native function: the GtkObject is the first -parameter passed in. The arguments are passed in the native -calling convention: chars, shorts, ints, longs may be packed -on the stack, or tucked in registers: it doesn't matter -because the same calling convention will be generated -inside the gtkmarshal code as is expected where you define -your handlers. - - -So the function named: - -gtk_marshal_BOOL__POINTER_INT_INT_UINT(GtkObject*, GtkSignalFunc, gpointer, GtkArg*); - -will call the #GtkSignalFunc assuming it was a function with signature: - -gboolean sigfunc(gpointer,gint,gint,guint); - - - - -Writing Custom Marshals - -Marshals are primarily used as arguments to gtk_signal_new(). -Sometimes, you may find that a marshaller you need isn't available -in the standard list. Then you have to write your own. - - -If you wish to define a signal with a new type of argument list. -Suppose you want 2 pointers and 2 integers. -You would write: - -typedef int (*GtkSignal_INT__POINTER_POINTER_INT_INT)( - gpointer, gpointer, gint, gint -); - -void marshal_INT__POINTER_POINTER_INT_INT(GtkObject* object, - GtkSignalFunc func, - gpointer func_data, - GtkArg* args) -{ - GtkSignal_NONE__POINTER_POINTER_INT_INT rfunc; - gint* return_val; - return_val = GTK_RETLOC_INT(args[4]); - rfunc = (GtkSignal_INT__POINTER_POINTER_INT_INT)func; - *return_val = (*rfunc)(object, - GTK_VALUE_POINTER(args[0]), - GTK_VALUE_POINTER(args[1]), - GTK_VALUE_INT(args[2]), - GTK_VALUE_INT(args[3]), - func_data); -} - - - - - - - - - - -#GtkSignal -The signal handling functions (of which marshallers are -really an implementation detail). - - - - - - - -Functions to adapt C structures to native calling convention. - - - -Signal Marshallers - - - - - - - - - - - - - - - - - - - -Menu Factory - - - - - - - - - - - - - - - - - - - -Private Information - - - - -GTK+ provides resource file mechanism for configuring -various aspects of the operation of a GTK+ program -at runtime. - - -Default files - -An application can cause GTK+ to parse a specific RC -file by calling gtk_rc_parse(). In addition to this, -certain files will be read at the end of gtk_init(). -Unless modified, the files looked for will be .gtkrc -in the users home directory, and -$localstatedir/gtk/gtkrc -($localstatedir defaults to -/usr/local/etc). - - -The set of these default files -can be retrieved with gtk_rc_get_default_files() -and modified with gtk_rc_add_default_file() and -gtk_rc_set_default_files(). - - -For each default file, in addition to the file itself, -GTK+ will look for a locale-specific file that will -be parsed in addition to the main file. For instance, -if LANG is set to ja_JP.ujis, -when loading the default file ~/.gtkrc -then GTK+ looks for ~/.gtkrc.ja_JP.ujis, -~/.gtkrc.ja_JP, and -~/.gtkrc.ja, and parses the -first one it finds. - - - -Pathnames and patterns - -A resource file defines a number of styles and key bindings and -attaches them to particular widgets. The attachment is done -by the widget, widget_class, -and class declarations. As an example -of such a statement: - -widget "mywindow.*.GtkEntry" style "my-entry-class" - -attaches the style "my-entry-class" -to all widgets whose widget class -matches the pattern -"mywindow.*.GtkEntry". - - -The patterns here are given in the standard shell glob -syntax. The "?" wildcard matches -any character, while "*" matches -zero or more of any character. The three types of -matching are against the widget path, the -class path and the class -heirarchy. Both the widget and the class paths consists of a -"." separated list of all the -parents of the widget and the widget itself from -outermost to innermost. The difference is that in -the widget path, the name assigned by -gtk_widget_set_name() is used -if present, otherwise the class name of the widget, while -for the widget path, the class name is always used. - - -So, if you have a GtkEntry named -"myentry", inside of a of a window -named "mywindow", then the -widget path is: - -"mwindow.GtkHBox.myentry" - -while the class path is: - -"GtkWindow.GtkHBox.GtkEntry" - - - -Matching against class is a little different. The pattern -match is done against all class names in the widgets -class heirarchy (not the layout heirarchy) in sequence, so the -pattern: - -class "GtkButton" style "my-style" - -will match not just GtkButton widgets, -but also GtkToggleButton and -GtkCheckButton widgets, since -those classes derive from GtkButton. - - - -Toplevel declarations - -An RC file is a text file which is composed of a sequence -of declarations. '#' characters delimit comments and -the portion of a line after a '#' is ignored when parsing -an RC file. - - - -The possible toplevel declarations are: - - - - binding name - { ... } - - Declare a binding set - - - - class pattern - [ style | binding [ : priority ]] - name - - Specify a style or binding set for a particular - branch of the inheritance heirarchy. - - - - include filename - - Parse another file at this point - - - - module_path path> - - Sets a path (a list of directories separated - by colons) that will be searched for theme engines referenced in - RC files. - - - - pixmap_path path> - - Sets a path (a list of directories separated - by colons) that will be searched for pixmaps referenced in - RC files. - - - - style name [ = - parent ] { ... } - - Declare a style - - - - widget pattern - [ style | binding [ : priority ]] - name - - Specify a style or binding set for a particular - group of widgets by matching on the widget pathname. - - - - widget_class pattern - [ style | binding [ : priority ]] - name - - Specify a style or binding set for a particular - group of widgets by matching on the class pathname. - - - - - - -Styles - -A RC style is specified by a style -declaration in a RC file, and then bound to widgets -with a widget, widget_class, -or class declaration. All styles -applying to a particular widget are composited together -with widget declarations overriding -widget_class declarations which, in -turn, override widget declarations. -Within each type of declaration, later declarations override -earlier ones. - - - -Within a style declaration, the possible -elements are: - - - - bg[state] = - color - - - Set color used for the background of most widgets. - - - - - fg[state] = - color - - - Set color used for the foreground of most widgets. - - - - - base[state] = - color - - - Set color used for the background of widgets displaying - editable text. This color is used for the background - of, among others, #GtkText, #GtkEntry, #GtkList, and #GtkClist. - - - - - text[state] = - color - - - Set color used for foreground of widgets using - base for the background color. - - - - - bg_text[state] = - color - - - Set a background pixmap to be used in place of - the bg color (or for #GtkText, - in place of the base color. - - - - - font = font - - - Set the font for a widget. - - - - - fontset = font - - - Set the fontset for a widget. Overrides any - font declarations. - - - - - stock["stock-id"] = { icon source specifications } - - - Defines the icon for a stock item. - - - - - - -The colors and background pixmaps are specified as a function of the -state of the widget. The states are: - - - - NORMAL - - - A color used for a widget in its normal state - - - - - ACTIVE - - - A variant of the NORMAL color used when the - widget is in the %GTK_STATE_ACTIVE state, and also for - the trough of a ScrollBar, tabs of a NoteBook - other than the current tab and similar areas. - Frequently, this should be a darker variant - of the NORMAL color. - - - - - PRELIGHT - - - A color used for widgets in the %GTK_STATE_PRELIGHT state. This - state is the used for Buttons and MenuItems - that have the mouse cursor over them, and for - their children. - - - - - SELECTED - - - A color used to highlight data selected by the user. - for instance, the selected ListItems in a List widget, and the - selection in an Editable widget. - - - - - INSENSITIVE - - - A color used for the background of widgets that have - been set insensitive with gtk_widget_set_sensitive() - - - - - - - -Colors can be specified as a string "&hash;rrrrggggbbbb", -"&hash;rrrgggbbb", "&hash;rrggbb", -or "&hash;rgb", where r -g, and b are -hex digits, or they can be specified as a triplet of floats -{ r, g, -b}. - - - -In a stock definition, icon sources are specified as a -4-tuple of image filename, text direction, widget state, and size, in that -order. Each icon source specifies an image filename to use with a given -direction, state, and size. The * character can be used as a -wildcard, and if direction/state/size are omitted they default to -*. So for example, the following specifies different icons to -use for left-to-right and right-to-left languages: - -stock["my-stock-item"] = -{ - { "itemltr.png", LTR, *, * }, - { "itemrtl.png", RTL, *, * } -} - -This could be abbreviated as follows: - -stock["my-stock-item"] = -{ - { "itemltr.png", LTR }, - { "itemrtl.png", RTL } -} - - - - -You can specify custom icons for specific sizes, as follows: - -stock["my-stock-item"] = -{ - { "itemmenusize.png", *, *, "gtk-menu" }, - { "itemtoolbarsize.png", *, *, "gtk-large-toolbar" } - { "itemgeneric.png" } /* implicit *, *, * as a fallback */ -} - -The sizes that come with GTK+ itself are "gtk-menu", -"gtk-small-toolbar", "gtk-large-toolbar", -"gtk-button", "gtk-dialog". Applications -can define other sizes. - - - -It's also possible to use custom icons for a given state, for example: -You can specify custom icons for specific sizes, as follows: - -stock["my-stock-item"] = -{ - { "itemprelight.png", *, PRELIGHT }, - { "iteminsensitive.png", *, INSENSITIVE }, - { "itemgeneric.png" } /* implicit *, *, * as a fallback */ -} - - - - -When selecting an icon source to use, GTK+ will consider text direction most -important, state second, and size third. It will select the best match based on -those criteria. If an attribute matches exactly (e.g. you specified -PRELIGHT or specified the size), GTK+ won't modify the image; -if the attribute matches with a wildcard, GTK+ will scale or modify the image to -match the state and size the user requested. - - - - -Key bindings - -Key bindings allow the user to specify actions to be -taken on particular key presses. The form of a binding -set declaration is: - - - -binding name { - bind key { - signalname (param, ...) - ... - } - ... -} - - - -key is a string consisting of a -series of modifiers followed by the name of a key. The -modifiers can be: - -<alt> -<control> -<mod1> -<mod2> -<mod3> -<mod4> -<mod5> -<release> -<shft> -<shift> - -<shft> is an alias for -<shift> and -<alt> is an alias for -<mod1>. - - - -The action that is bound to the key is a sequence -of signal names (strings) followed by parameters for -each signal. The signals must be action signals. -(See gtk_signal_new()). Each parameter can be -a float, integer, string, or unquoted string -representing an enumeration value. The types of -the parameters specified must match the types of the -parameters of the signal. - - - -Binding sets are connected to widgets in the -same manner as styles, with one addition. -A priority can be specified for each pattern, -and within each type of pattern, binding sets -override other binding sets first by priority, -and only then by order of specification. (Later -overrides earlier). The priorities that can -be specified are (highest to lowest): - -HIGHEST -RC -APPLICATION -GTK -LOWEST - -RC is the default for bindings -read from an RC file, APPLICATION -should be used for bindings an application sets -up, and GTK is used for bindings -that GTK+ creates internally. - - - - - - - - - - - -Routines for handling resource files - - - -Resource Files - - - - - -The selection mechanism provides the basis for different types -of IPC between processes. In particular, drag and drop and -#GtkClipboard work via selections. You will very seldom or -never need to use most of the functions in this section directly; -#GtkClipboard provides a nicer interface to the same functionality. - - -Some of the datatypes defined this section are used in -the #GtkClipboard and drag-and-drop API's as well. The -#GtkTargetEntry structure and #GtkTargetList objects represent -lists of data types that are supported when sending or -receiving data. The #GtkSelectionData object is used to -store a chunk of data along with the data type and other -associated information. - - - - - - - - -#GtkWidget -Much of the operation of selections happens via - signals for #GtkWidget. In particular, if you are - using the functions in this section, you may need - to pay attention to ::selection_get, - ::selection_received, and :selection_clear_event - signals. - - - - - - - - -Functions for handling inter-process communication via selections. - - - -Selections - - - - -What are signals? - -Signals are a way to get notification when something happens -and to customize object behavior according to the -user's needs. -Every signal is uniquely identified by a name, -"class_name::signal_name", where signal_name might be something like -"clicked" and class_name might be "GtkButton". Note that some other class -may also define a "clicked" callback, so long as it doesn't derive from -#GtkButton. - - -When they are created, they are also assigned a unique positive integer, -the signal id (1 is the first signal id- 0 is used to flag an error). -Each is also tied to an array of types that describes -the prototype of the function pointer(s) (handlers) you may -connect to the signal. Finally, every signal has -a default handler that is given by a function pointer -in its class structure: it is run by default whenever the -signal is emitted. (It is possible that a signal will -be emitted and a user-defined handler will prevent the default handler -from being run.) - - -Signals are used by everyone, but they are only -created on a per class basis-- so you should call -call gtk_signal_new() unless you are writing -a new #GtkObject type. However, if you want to make a new signal -for an existing type, you may use gtk_object_class_user_signal_new() -to create a signal that doesn't correspond to a class's builtin -methods. - - - -How are signals used? - -There are two basic actions in the signal handling game. -If you want notification of an event, you must connect -a function pointer and a data pointer to that signal; the data pointer -will be passed as the last argument to the function (so long as you -are using the default marshalling functions). -You will receive a connection id, a unique positive integer -corresponding to that attachment. - - -Functions that want to notify the user of certain actions, -emit signals. - - - -Basic Terminology - - - -signal -A class method, e.g. GtkButton::clicked. -More precisely it is a unique class-branch/signal-name pair. -This means you may not define a signal handler for a class which -derives from GtkButton that is called clicked, -but it is okay to share signals names if they are separate in -the class tree. - - - - -default handler -The object's internal method which is invoked -when the signal is emitted. - - - - -user-defined handler -A function pointer and data connected -to a signal (for a particular object). -There are really two types: those which are connected -normally, and those which are connected by one -of the connect_after functions. The connect_after handlers -are always run after the default handler. -Many toolkits refer to these as callbacks. - - - - -emission -the whole process of emitting a signal, -including the invocation of all -the different handler types mentioned above. - - - - -signal id -The unique positive (nonzero) integer -used to identify a signal. It can be used instead of -a name to many functions for a slight performance -improvement. - - - - -connection id -The unique positive (nonzero) integer -used to identify the connection of a user-defined handler -to a signal. Notice that it is allowed to connect the -same function-pointer/user-data pair twice, so -there is no guarantee that a function-pointer/user-data -maps to a unique connection id. - - - - - - - -A brief note on how they work. - -The functions responsible for translating an array of #GtkArgs -to your C compiler's normal semantics are called Marshallers. -They are identified by -gtk_marshal_return_value__parameter_list() -for example a C function returning a gboolean and taking a gint -can be invoked by using gtk_marshal_BOOL__INT(). -Not all possibly combinations of return/params are available, -of course, so if you are writing a #GtkObject with parameters -you might have to write a marshaller. - - - - - - - - - -#GtkObject -The base class for things which emit signals. - - - - - - - -Object methods and callbacks. - - - -Signals - - - - - - - - - - - - - - - - - - - -Stock Items - - - - - - - - - - - - - - - - - - - -Styles - - - - - - - - - - - - - - - - - - - -Themes - - - - - - - - - - - - - - - - - - - -GtkModelSimple - - - - - - - - - - - - - - - - - - - -GtkTreeView - - - - -Gtk's type system is extensible. Because of that, types have to be -managed at runtime. - - - - - - - - - - -Handle run-time type creation. - - - -Types - - - - -A button box should be used to provide a consistent layout of buttons -throughout your application. There is one default layout and a default -spacing value that are persistant across all #VButtonBox widgets. - - -The layout/spacing can then be altered by the programmer, or if desired, by -the user to alter the 'feel' of a program to a small degree. - - -A #VButtonBox is created with gtk_vbutton_box_new(). Buttons are packed into -a button box the same way as any other box, using gtk_box_pack_start() or -gtk_box_pack_end(). - - -The default spacing between buttons can be set with -gtk_vbutton_box_set_spacing_default() and queried with -gtk_vbutton_box_get_spacing_default(). - - -The arrangement and layout of the buttons can be changed using -gtk_vbutton_box_set_layout_default() and queried with -gtk_vbutton_box_get_layout_default(). - - - - - - - -#GtkBox -Used to pack widgets into button boxes. - -#GtkButtonBox -Provides functions for controlling button boxes. - - -#GtkHButtonBox -Pack buttons horizontally. - - - - - - -a container for arranging buttons vertically. - - - -GtkVButtonBox - - - - -GtkVBox is a container that organizes child widgets into a single column. - - - -Use the #GtkBox packing interface to determine the arrangement, -spacing, height, and alignment of GtkVBox children. - - - -All children are allocated the same width. - - - - - - - - -#GtkHBox -a sister class that organizes widgets into a row. - - - - - - - -vertical container box - - - -GtkVBox - - - - - - - - - - - - - - - - - - - -GtkViewport - - - - -The VPaned widget is a container widget with two -children arranged vertically. The division between -the two panes is adjustable by the user by dragging -a handle. See #GtkPaned for details. - - - - - - - - - - -A container with two panes arranged vertically. - - - -GtkVPaned - - - - - NOTE this widget is considered too specialized/little-used for - GTK+, and will in the future be moved to some other package. If - your application needs this widget, feel free to use it, as the - widget does work and is useful in some applications; it's just not - of general interest. However, we are not accepting new features for - the widget, and it will eventually move out of the GTK+ - distribution. - - -The VRuler widget is a widget arranged vertically creating a ruler that is -utilized around other widgets such as a text widget. The ruler is used to show -the location of the mouse on the window and to show the size of the window in -specified units. The available units of measurement are GTK_PIXELS, GTK_INCHES -and GTK_CENTIMETERS. GTK_PIXELS is the default. -rulers. - - - - - - - - - - -A vertical ruler. - - - -GtkVRuler - - - - -The #GtkVScale widget is used to allow the user to select a value using -a vertical slider. -A #GtkAdjustment is used to set the initial value, the lower -and upper bounds, and the step and page increments. - - -The position to show the current value, and the number of decimal places -shown can be set using the parent #GtkScale class's functions. - - - - - - - - - - -a vertical slider widget for selecting a value from a range. - - - -GtkVScale - - - - -The VScrollbar widget is a widget arranged vertically creating a scroll bar. See -#GtkScrollbar for details on scrollbars. #GtkAdjustment pointers may be added to -handle the adjustment of the scrollbars or it may be left NULL in which case one -will be created you. See #GtkAdjustment for details. - - - - - - - - - - -A vertical scrollbar - - - -GtkVScrollbar - - - - -The #GtkVSeparator widget is a vertical separator, used to group the -widgets within a window. It displays a vertical line with a shadow to -make it appear sunken into the interface. - - - - - - - -#GtkHSeparator -a horizontal separator. - - - - - - -a vertical separator. - - - -GtkVSeparator - - - - - - - - - - - - - - - - - - - -GtkWidget - - - - - - - - - - - - - - - - - - - -GtkWindow - - - - -A macro to check whether a child widget of the CList -has the focus. - - -@clist: The #GtkCList widget to check. - - - - - - -@obj: - - - - - - - - - - - - -@type: -@action: - - - -Test whether a GtkObject's arguments have been prepared. - - -@obj: the object to examine. - - - -Get the number of signals defined by this object. - - -@obj: the object to query. - - - -Get the array of signals defined for this object. - - -@obj: the object to fetch the signals from. - - - - - - -@wid: - - - - - - -@wid: -@flag: - - - - - - -@wid: -@flag: - - - -A macro that returns a GList that contains the selection of the root tree of @obj. - - -@obj: A pointer to the #GtkTree. @obj will accept any pointer, but it the pointer does not point to a #GtkTree, the results are undefined. - - - -The first "flat" (no struct) enumerated type value. - - - - - -The last "flat" (no struct) enumerated type value. - - - - - -Hide the name of gtk_identifier_get_type - - - - - -Combine a fundemantal type and a sequence number to create a gtk type. - - -@parent_t: -@seqno: - - - -No idea. - - - - - -Convert a gtk type into its sequence number - - -@type: - - - -The first structured enumerated type value. - - - - - -The last structured enumerated type value. - - - - - -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_ARGS - - -@a: - - - -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_CALLBACK - - -@a: - - - -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_CALLBACK - - -@a: - - - -Use to get the value of a GtkArg whose GtkType is GTK_TYPE_C_FOREIGN - - -@a: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@obj: - - - - - - -@GTK_CELL_RENDERER_SELECTED: -@GTK_CELL_RENDERER_PRELIT: -@GTK_CELL_RENDERER_INSENSITIVE: - - - - - - -@GTK_DEBUG_OBJECTS: -@GTK_DEBUG_MISC: -@GTK_DEBUG_SIGNALS: -@GTK_DEBUG_DND: -@GTK_DEBUG_PLUGSOCKET: - - - -Deprecated. - - - - - -Indicates that the user has activated the widget -in some fashion. Generally, this will be done -with a keystroke. (The default binding for this -action is Return for #GtkEntry and -Control-Return for #GtkText.) - - -@editable: the object which received the signal. - - - -Indicates that the user has changed the contents -of the widget. - - -@editable: the object which received the signal. - - - -An action signal. Causes the characters in the current selection to -be copied to the clipboard. - - -@editable: the object which received the signal. - - - -An action signal. Causes the characters in the current -selection to be copied to the clipboard and then deleted from -the widget. - - -@editable: the object which received the signal. - - - -This signal is emitted when text is deleted from -the widget by the user. The default handler for -this signal will normally be responsible for inserting -the text, so by connecting to this signal and then -stopping the signal with gtk_signal_emit_stop(), it -is possible to modify the inserted text, or prevent -it from being inserted entirely. The @start_pos -and @end_pos parameters are interpreted as for -gtk_editable_delete_text() - - -@editable: the object which received the signal. -@start_pos: the starting position. -@end_pos: the end position. - - - -This signal is emitted when text is inserted into -the widget by the user. The default handler for -this signal will normally be responsible for inserting -the text, so by connecting to this signal and then -stopping the signal with gtk_signal_emit_stop(), it -is possible to modify the inserted text, or prevent -it from being inserted entirely. - - -@editable: the object which received the signal. -@new_text: the new text to insert. -@new_text_length: the length of the new text. -@position: the position at which to insert the new text. - this is an in-out paramter. After the signal - emission is finished, it should point after - the newly inserted text. - - - -An action signal. Delete a single character. - - -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - - - -An action signal. Delete a single line. - - -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - - - -An action signal. Delete a single word. - - -@editable: the object which received the signal. -@direction: the direction in which to delete. Positive - indicates forward deletion, negative, backwards deletion. - - - -An action signal. Move the cursor position. - - -@editable: the object which received the signal. -@x: horizontal distance to move the cursor. -@y: vertical distance to move the cursor. - - - -An action signal. Move the cursor by pages. - - -@editable: the object which received the signal. -@x: Number of pages to move the cursor horizontally. -@y: Number of pages to move the cursor vertically. - - - -An action signal. Move the cursor to the given column. - - -@editable: the object which received the signal. -@column: the column to move to. (A negative value indicates - the last column) - - - -An action signal. Move the cursor to the given row. - - -@editable: the object which received the signal. -@row: the row to move to. (A negative value indicates - the last row) - - - -An action signal. Move the cursor by words. - - -@editable: the object which received the signal. -@num_words: The number of words to move the -cursor. (Can be negative). - - - -An action signal. Causes the contents of the clipboard to -be pasted into the editable widget at the current cursor -position. - - -@editable: the object which received the signal. - - - -Determines if the user can edit the text in the editable -widget or not. This is meant to be overriden by -child classes and should not generally useful to -applications. - - -@editable: the object which received the signal. -@is_editable: %TRUE if the user is allowed to edit the text - in the widget. - - - -A boolean indicating whether the widget is editable by -the user. - - - - - -The position of the cursor. - - - - - -A set of bit flags used to specify the filter being set -when calling gtk_font_selection_dialog_set_filter() or -gtk_font_selection_set_filter(). - - -@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user. -@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the -'Filter' page of the #GtkFontSelection widget. - - - -A set of bit flags used to specify the type of fonts shown -when calling gtk_font_selection_dialog_set_filter() or -gtk_font_selection_set_filter(). - - -@GTK_FONT_BITMAP: bitmap fonts. -@GTK_FONT_SCALABLE: scalable fonts. -@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts. -@GTK_FONT_ALL: a bitwise combination of all of the above. - - - - - - -@object: -@tables: -@compose_buffer: -@tentative_match: -@tentative_match_len: - - - -Internal to #GtkLabel. - - - - - - - - -@widget: -@user_data: - - - - - - -@path: -@accelerator: -@callback: -@callback_data: -@widget: - - - - - - -@path: -@type: -@accel_group: -@widget: -@subfactories: - - - - - - -@GTK_MENU_FACTORY_MENU: -@GTK_MENU_FACTORY_MENU_BAR: -@GTK_MENU_FACTORY_OPTION_MENU: - - - - - - -@path: -@widget: - - - - - - -@parent: -@stamp: - - - -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the user data and objects -and swapped when the signal handler is invoked. - - -This is useful for handlers that are primarily notifying -other objects and could just invoke an already existing function -if the parameters were swapped. -See gtk_signal_connect_object() for more details. - - - - - -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the user data and objects -and swapped when the signal handler is invoked, -and so that the handler is invoked after all others. - - -See gtk_signal_connect_object_after() for more details. - - - - - -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object. - - - - - -Setting this with a GtkType of GTK_TYPE_SIGNAL connects -the signal to the object, so that the signal is always run -after other user handlers and the default handler. - - - - - - - - -@PRIVATE_GTK_USER_STYLE: -@PRIVATE_GTK_RESIZE_PENDING: -@PRIVATE_GTK_RESIZE_NEEDED: -@PRIVATE_GTK_LEAVE_PENDING: -@PRIVATE_GTK_HAS_SHAPE_MASK: -@PRIVATE_GTK_IN_REPARENT: -@PRIVATE_GTK_DIRECTION_SET: -@PRIVATE_GTK_DIRECTION_LTR: - - - -A function which you can use to clean up when the -signal handler is destroyed. - - -For example, if your handler requires a few variables -that you made into a struct and allocated (using g_new() -or something), then you will probably want to free -it as soon as the hook is destroyed. This will -allow you to do that. (For this in particular -it is convenient to pass g_free() as a #GtkSignalDestroy -function). - - -@data: The user data associated with the hook that is being -destroyed. - - - -This is currently a hack left in for a scheme wrapper library. -It may be removed. - - -Don't use it. - - -@object: The object which emits the signal. -@data: The user data associated with the hook. -@nparams: The number of parameters to the function. -@args: The actual values of the arguments. -@arg_types: The types of the arguments. -@return_type: The type of the return value from the function -or #GTK_TYPE_NONE for no return value. - - - -This structure contains all the information about a particular -signal: its name, the type it affects, the signature of the handlers, -and its unique identifying integer. - - -@object_type: -@signal_id: -@signal_name: -@is_user_signal: -@signal_flags: -@return_val: -@nparams: -@params: - - - -Holds the data for a statusbar message. text holds the actual text string. context_id is the context that this message is associated with, and message_id is this particular message's identifier. However, these fields should not be modified directly. - - -@text: -@context_id: -@message_id: - - - - - - - - - - - - -@textbuffer: the object which received the signal. -@arg1: -@arg2: -@arg3: - - - - - - - - - - - - - - - -A #GtkJustification for the text. This is only used when the tag is -applied to the first character in a paragraph. - - - - - - - - - - - -Pixel width of the left margin of the text for lines after the first -line in a wrapped paragraph. - - - - - - - - - - - -Pixels to offset the text horizontally or vertically, useful to -produce superscript and subscript. - - - - - - - - - - - - - - - - - - - - - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: - - - - - - -@textview: the object which received the signal. -@arg1: - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: -@arg3: - - - - - - -@textview: the object which received the signal. -@arg1: -@arg2: -@arg3: - - - - - - -@textview: the object which received the signal. - - - - - - -@textview: the object which received the signal. -@arg1: - - - - - - -@GTK_TEXT_DELETE_CHAR: -@GTK_TEXT_DELETE_HALF_WORD: -@GTK_TEXT_DELETE_WHOLE_WORD: -@GTK_TEXT_DELETE_HALF_WRAPPED_LINE: -@GTK_TEXT_DELETE_WHOLE_WRAPPED_LINE: -@GTK_TEXT_DELETE_HALF_LINE: -@GTK_TEXT_DELETE_WHOLE_LINE: -@GTK_TEXT_DELETE_WHITESPACE: -@GTK_TEXT_DELETE_WHITESPACE_LEAVE_ONE: - - - - - - -@GTK_TEXT_MOVEMENT_CHAR: -@GTK_TEXT_MOVEMENT_POSITIONS: -@GTK_TEXT_MOVEMENT_WORD: -@GTK_TEXT_MOVEMENT_WRAPPED_LINE: -@GTK_TEXT_MOVEMENT_LINE: -@GTK_TEXT_MOVEMENT_LINE_ENDS: -@GTK_TEXT_MOVEMENT_BUFFER_ENDS: - - - - - - -@GTK_TEXT_SCROLL_TO_TOP: -@GTK_TEXT_SCROLL_TO_BOTTOM: -@GTK_TEXT_SCROLL_PAGE_DOWN: -@GTK_TEXT_SCROLL_PAGE_UP: - - - - - - - - - - - - -@GTK_TREE_SELECTION_SINGLE: -@GTK_TREE_SELECTION_MULTI: - - - - - - -@GTK_TREE_VIEW_COLUMN_RESIZEABLE: -@GTK_TREE_VIEW_COLUMN_AUTOSIZE: -@GTK_TREE_VIEW_COLUMN_FIXED: - - - - - - -@model: -@flags: -@tree: -@tab_offset: -@button_pressed_node: -@button_pressed_tree: -@children: -@width: -@height: -@hadjustment: -@vadjustment: -@bin_window: -@header_window: -@anchor: -@cursor: -@cursor_drag: -@xor_gc: -@drag_pos: -@x_drag: -@prelight_node: -@prelight_tree: -@prelight_offset: -@selection: -@columns: -@column: -@header_height: - - - -A structure used to return values from @gtk_type_query. - - -@type: -@type_name: -@object_size: -@class_size: - - - -the #GtkAdjustment which sets the range of the scale. - - - - - - - - - - - - - - -@viewport: the object which received the signal. -@arg1: -@arg2: - - - - - - - - - - - - - - - - - - - - - - - - -@widget: the object which received the signal. -@accel_signal_id: -@accel_group: -@accel_key: -@accel_mods: -@accel_flags: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@message: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@arg1: - - - - - - -@widget: the object which received the signal. -@drag_context: - - - - - - -@widget: the object which received the signal. -@drag_context: - - - - - - -@widget: the object which received the signal. -@drag_context: -@data: -@info: -@time: - - - - - - -@widget: the object which received the signal. -@drag_context: -@x: -@y: -@data: -@info: -@time: - - - - - - -@widget: the object which received the signal. -@drag_context: -@x: -@y: -@time: -@Returns: - - - - - - -@widget: the object which received the signal. -@drag_context: - - - - - - -@widget: the object which received the signal. -@drag_context: -@time: - - - - - - -@widget: the object which received the signal. -@drag_context: -@x: -@y: -@time: -@Returns: - - - - - - -@widget: the object which received the signal. -@area: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@old_parent: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@accel_group: -@accel_key: -@accel_mods: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@data: -@info: -@time: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. -@data: -@time: - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@allocation: - - - - - - -@widget: the object which received the signal. -@requisition: - - - - - - -@widget: the object which received the signal. -@state: - - - - - - -@widget: the object which received the signal. -@previous_style: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. -@event: -@Returns: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@window: the object which received the signal. -@event: -@Returns: - - - - - - -@window: the object which received the signal. -@widget: - - - -If the window can be resized to a larger size by the user. - - - - - -If the window can be resized to a smaller size by the user. - - - - - -If the window shrinks automatically when widgets within it shrink. - - - - - - - - - - - - - - - - - - - - - - - -If the window is modal, i.e. it grabs all GTK+ events. - - - - - -The title of the window. - - - - - -The type of the window. - - - - - -The position of the window. - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - -Initializes a previously allocated #GtkCList widget for use. This should not -normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. - - -@clist: A pointer to an uninitialized #GtkCList widget. -@columns: The number of columns the #GtkCList should have. -@titles: An array of strings that should be used as the titles i -of the columns. There should be enough strings in the array for -the number of columns specified. - - - -Controls whether opacity can be set with the #GtkColorSelection. -If this functionality is enabled, the necessary additional widgets -are added to the #GtkColorSelection and the opacity value can be -retrieved via the fourth value in the color array returned by -the gtk_color_selection_get_color() function. - - -@colorsel: a #GtkColorSelection. -@use_opacity: a boolean indicating whether the opacity selection -is enabled. - - - - - - -@Returns: - - - - - - -@container: - - - - - - -@container: - - - -This function is not usually used by users. - - -@ctree: -@columns: -@tree_column: -@titles: - - - - - - - - - - - - -@style: -@window: -@state_type: -@shadow_type: -@x: -@y: -@width: -@height: - - - - - - -@style: -@window: -@state_type: -@shadow_type: -@x: -@y: -@width: -@height: - - - - - - -@style: -@window: -@state_type: -@shadow_type: -@arrow_type: -@x: -@y: -@width: -@height: - - - -Causes the "changed" signal to be emitted. - - -@editable: a #GtkEditable widget. - - - -Claim or disclaim ownership of the PRIMARY X selection. - - -@editable: a #GtkEditable widget. -@claim: if %TRUE, claim the selection, otherwise, disclaim it. -@time: the timestamp for claiming the selection. - - - -Sets one of the two font filters, to limit the fonts shown. - - -@fsd: a #GtkFontSelectionDialog. -@filter_type: which of the two font filters to set, either -#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter -can be changed by the user, but the base filter is permanent. -@font_type: the types of font to be shown. This is a bitwise combination of -#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, -or #GTK_FONT_ALL to show all three font types. -@foundries: a NULL-terminated array of strings containing foundry names which -will be shown, or NULL to show all foundries. -@weights: a NULL-terminated array of strings containing weight names which -will be shown, or NULL to show all weights. -@slants: a NULL-terminated array of strings containing slant names which -will be shown, or NULL to show all slants. -@setwidths: a NULL-terminated array of strings containing setwidth names which -will be shown, or NULL to show all setwidths. -@spacings: a NULL-terminated array of strings containing spacings which -will be shown, or NULL to show all spacings. -@charsets: a NULL-terminated array of strings containing charset names which -will be shown, or NULL to show all charsets. - - - -Sets one of the two font filters, to limit the fonts shown. - - -@fontsel: a #GtkFontSelection. -@filter_type: which of the two font filters to set, either -#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter -can be changed by the user, but the base filter is permanent. -@font_type: the types of font to be shown. This is a bitwise combination of -#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, -or #GTK_FONT_ALL to show all three font types. -@foundries: a NULL-terminated array of strings containing foundry names which -will be shown, or NULL to show all foundries. -@weights: a NULL-terminated array of strings containing weight names which -will be shown, or NULL to show all weights. -@slants: a NULL-terminated array of strings containing slant names which -will be shown, or NULL to show all slants. -@setwidths: a NULL-terminated array of strings containing setwidth names which -will be shown, or NULL to show all setwidths. -@spacings: a NULL-terminated array of strings containing spacings which -will be shown, or NULL to show all spacings. -@charsets: a NULL-terminated array of strings containing charset names which -will be shown, or NULL to show all charsets. - - - - - - -@Returns: - - - -Get the type of GtkIdentifier. - - -@Returns: GtkType -- the enumerated type of something. - - - - - - -@context_simple: -@data: -@max_seq_len: -@n_seqs: - - - - - - -@Returns: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - - - - - - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - -@object: -@func: -@func_data: -@args: - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - - -@factory: -@entries: -@nentries: - - - - - - -@factory: -@subfactory: -@path: - - - - - - -@factory: - - - - - - -@factory: -@path: -@Returns: - - - - - - -@type: -@Returns: - - - - - - -@factory: -@entries: -@nentries: - - - - - - -@factory: -@paths: -@npaths: - - - - - - -@factory: -@subfactory: -@path: - - - - - - -@Returns: - - - - - - -@simple: -@path: -@iter: - - - - - - -@simple: -@path: -@iter: - - - - - - -@simple: -@path: -@iter: - - - - - - -@simple: -@path: -@iter: - - - -Private function to get an argument and argument info from an object. - - -@object: the object whose argument should be retrieved. -@arg: the argument, for the name on input, the rest is filled on output. -@info: a #GtkArgInfo structure to optionally fill in. - - - -Query information about an argument type. - - -@object_type: type of object to query about. -@arg_name: name of the argument. -@info_p: pointer to be filled in with a pointer to the GtkArgInfo. -@Returns: an error message, or NULL on success. -It is the caller's responsibility to call g_free() in the event of error. - - - -Private function to set an argument and argument info to an object. - - -@object: the object whose argument should be set. -@arg: the argument. -@info: infomation about this type of argument in general. - - - -Private: Gets an array of #GtkArgs from a va_list C structure. - - -@object_type: the type of object to collect arguments for. -@arg_list_p: pointer to be filled in with a list of parsed arguments. -@info_list_p: optional pointer for a returned list #GtkArgInfos. -@first_arg_name: name of first argument. -@var_args: value of first argument, followed by more key/value pairs, -terminated by NULL. -@Returns: an error message, or NULL on success. -It is the caller's responsibility to call g_free() in the event of error. - - - -Add an array of signals to a #GtkObjectClass. -Usually this is called when registering a new type of object. - - -@klass: the object class to append signals to. -@signals: the signals to append. -@nsignals: the number of signals being appended. - - - -Define a signal-handler for a new signal on an already defined -object. - - -See the signal documentation for more general information. - - -@klass: the object class to define the signal for. -@name: the name of the signal. -@signal_flags: the default emission behavior for the signal. -See gtk_signal_new(). -@marshaller: a function that will take an array of GtkArgs -and invoke the appropriate handler with the normal calling -conventions. -@return_val: specify the return-value type for the signal -(or GTK_TYPE_NONE for no return-value). -@nparams: specify the number of parameters the signal -receives from the caller of gtk_signal_emit(). -@Varargs: list of nparams #GtkTypes to pass to the signal handlers. -@Returns: the signal id. (See #GtkSignals) - - - -Define a signal-handler for a new signal on an already defined -object. - - -@klass: the object class to define the signal for. -@name: the name of the signal. -@signal_flags: the default emission behavior for the signal. -See gtk_signal_new(). -@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array -of arguments, and invokes the function using the appropriate -calling conventions. Usually just select a function -out of gtkmarshal.h. -@return_val: specify the return-value type for the signal (possibly -#GTK_TYPE_NONE). -@nparams: specify the number of parameters the signal -receives from the caller of gtk_signal_emit(). -@params: array of #GtkTypes the signal handlers for this signal -should have in their prototype (of length nparams). -@Returns: the signal id. (See #GtkSignals) - - - -Mark an allocated object as constructed. -This is used for situations -that require precise control of the construction process. - - -This is done when gtk_object_default_construct() is inadequate. -In #GtkCList the need arises because #GtkCList does construction work that -must happen after its derivers. This work -cannot be done in an initializer function, so an alternate -constructor is mandatory. It calls gtk_object_constructed() to -indicate it has done its job, so that no other constructor will -be invoked. - - -Normally this function is just automatically run from -gtk_object_default_construct(). +This signal is emitted when text is inserted into +the widget by the user. The default handler for +this signal will normally be responsible for inserting +the text, so by connecting to this signal and then +stopping the signal with gtk_signal_emit_stop(), it +is possible to modify the inserted text, or prevent +it from being inserted entirely. -@object: object which has been constructed. This is usually -done automatically by gtk_object_new() and gtk_object_newv(). +@editable: the object which received the signal. +@new_text: the new text to insert. +@new_text_length: the length of the new text. +@position: the position at which to insert the new text. + this is an in-out paramter. After the signal + emission is finished, it should point after + the newly inserted text. - + -This function is called to construct arguments that haven't been initialized -but have the #GTK_ARG_CONSTRUCT flag set. +An action signal. Delete a single character. + +@editable: the object which received the signal. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. + + -All number arguments are set to 0. All pointers and strings -are set to NULL. +An action signal. Delete a single line. + +@editable: the object which received the signal. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. + + -Normally invoked by gtk_object_new() automatically; gtk_type_new() can -be used to bypass it. +An action signal. Delete a single word. -@object: the object to initialize. +@editable: the object which received the signal. +@direction: the direction in which to delete. Positive + indicates forward deletion, negative, backwards deletion. - + -Gets an array of argument values from an object. +An action signal. Move the cursor position. -@object: the object to get arguments from. -@n_args: the number of arguments to query. -@args: the arguments to fill in. +@editable: the object which received the signal. +@x: horizontal distance to move the cursor. +@y: vertical distance to move the cursor. - + -Construct an object with an array of arguments. +An action signal. Move the cursor by pages. -@object_type: the type of the object to create. -@n_args: the number of arguments to set. -@args: an array of n_args arguments (which are name and value pairs). -@Returns: the new GtkObject. +@editable: the object which received the signal. +@x: Number of pages to move the cursor horizontally. +@y: Number of pages to move the cursor vertically. - + -Get all the arguments that may be used for a given type. +An action signal. Move the cursor to the given column. + +@editable: the object which received the signal. +@column: the column to move to. (A negative value indicates + the last column) + + -In Java, this type of mechanism is called -introspection. It is used by applications -like Glade, that have to determine what can be done to an object -at run-time. +An action signal. Move the cursor to the given row. -@class_type: the GtkType of the ObjectClass -(returned from GTK_OBJECT_CLASS(class)->type for example). -@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to -each argument. You must g_free() this if you request it. -@n_args: the number of arguments is returned in this field. -@Returns: an array of arguments, that you must deallocate with g_free(). +@editable: the object which received the signal. +@row: the row to move to. (A negative value indicates + the last row) - + -Set an array of arguments. +An action signal. Move the cursor by words. -@object: the object whose arguments should be set. -@n_args: the number of arguments to set. -@args: the desired values, as an array of #GtkArgs (which contain -the names, types, and values of the arguments). +@editable: the object which received the signal. +@num_words: The number of words to move the +cursor. (Can be negative). - + - +An action signal. Causes the contents of the clipboard to +be pasted into the editable widget at the current cursor +position. -@style: -@window: -@state_type: -@shadow_type: -@area: -@widget: -@detail: -@x: -@y: -@width: -@height: - - - +@editable: the object which received the signal. + + +Determines if the user can edit the text in the editable +widget or not. This is meant to be overriden by +child classes and should not generally useful to +applications. -@style: -@window: -@state_type: -@shadow_type: -@area: -@widget: -@detail: -@x: -@y: -@width: -@height: - - - +@editable: the object which received the signal. +@is_editable: %TRUE if the user is allowed to edit the text + in the widget. + + +A boolean indicating whether the widget is editable by +the user. -@style: -@window: -@state_type: -@shadow_type: -@area: -@widget: -@detail: -@arrow_type: -@x: -@y: -@width: -@height: - + -Internal function used by #GtkHPaned and #GtkVPaned +The position of the cursor. -@paned: -@allocation: -@child1_req: -@child2_req: - + -Internal function. +A set of bit flags used to specify the filter being set +when calling gtk_font_selection_dialog_set_filter() or +gtk_font_selection_set_filter(). +@GTK_FONT_FILTER_BASE: the base filter, which can't be changed by the user. +@GTK_FONT_FILTER_USER: the user filter, which can be changed from within the +'Filter' page of the #GtkFontSelection widget. - + - +A set of bit flags used to specify the type of fonts shown +when calling gtk_font_selection_dialog_set_filter() or +gtk_font_selection_set_filter(). -@ruler: the gtkruler +@GTK_FONT_BITMAP: bitmap fonts. +@GTK_FONT_SCALABLE: scalable fonts. +@GTK_FONT_SCALABLE_BITMAP: scaled bitmap fonts. +@GTK_FONT_ALL: a bitwise combination of all of the above. - + -@ruler: the gtkruler +@object: +@tables: +@compose_buffer: +@tentative_match: +@tentative_match_len: - + -Add an emission hook for a type of signal, for any object. -(with control of what happens when the hook is -destroyed). +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the user data and objects +and swapped when the signal handler is invoked. - -@signal_id: the type of signal add the hook for. -@hook_func: the function to invoke to handle the hook. -@data: the user data passed in to hook_func. -@destroy: a function to invoke when the hook is destroyed, -to clean up any allocation done just for this -signal handler. -@Returns: the id (that you may pass as a parameter -to gtk_signal_remove_emission_hook()). - - -Returns whether a connection id is valid (and optionally not blocked). +This is useful for handlers that are primarily notifying +other objects and could just invoke an already existing function +if the parameters were swapped. +See gtk_signal_connect_object() for more details. -@object: the object to search for the desired handler. -@handler_id: the connection id. -@may_be_blocked: whether it is acceptable to return a blocked -handler. -@Returns: TRUE if the signal exists and wasn't blocked, -unless #may_be_blocked was specified. FALSE otherwise. - + -Destroy all the signal handlers connected to an object. -This is done automatically when the object is destroyed. +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the user data and objects +and swapped when the signal handler is invoked, +and so that the handler is invoked after all others. -This function is labeled private. +See gtk_signal_connect_object_after() for more details. -@object: the object whose signal handlers should be destroyed. - + - +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object. - + -Find out the recursion depth of emissions for a particular type -of signal and object. (So it will -always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified) -This is a way to avoid recursion: you can see if -you are currently running in that signal handler and emit it only -if you are. - -Another way to look at it is that this number increases -by one when #gtk_signal_emit(), et al, are called, -and decreases by one when #gtk_signal_emit() returns. +Setting this with a GtkType of GTK_TYPE_SIGNAL connects +the signal to the object, so that the signal is always run +after other user handlers and the default handler. -@object: the object with the signal handler. -@signal_id: the signal id. -@Returns: the recursion depth of emissions of this signal for this -object. - + -Find out the recursion depth of emissions for a particular type -of signal and object. Just like gtk_signal_n_emissions() -except it will lookup the signal id for you. + -@object: the object with the signal handler. -@name: the signal name. -@Returns: the recursion depth of emissions of this signal for this -object. +@PRIVATE_GTK_USER_STYLE: +@PRIVATE_GTK_RESIZE_PENDING: +@PRIVATE_GTK_RESIZE_NEEDED: +@PRIVATE_GTK_LEAVE_PENDING: +@PRIVATE_GTK_HAS_SHAPE_MASK: +@PRIVATE_GTK_IN_REPARENT: +@PRIVATE_GTK_DIRECTION_SET: +@PRIVATE_GTK_DIRECTION_LTR: - + -Obtain information about a signal. +A function which you can use to clean up when the +signal handler is destroyed. + + +For example, if your handler requires a few variables +that you made into a struct and allocated (using g_new() +or something), then you will probably want to free +it as soon as the hook is destroyed. This will +allow you to do that. (For this in particular +it is convenient to pass g_free() as a #GtkSignalDestroy +function). -@signal_id: the signal type identifier. -@Returns: a pointer to a GtkSignalQuery structure -which contains all the information, or NULL. -The pointer is allocated just for you: you must g_free() it. +@data: The user data associated with the hook that is being +destroyed. - + -These set default functions to call when the user didn't -supply a function when connecting. (These are rarely -used, and probably only for language bindings) +This is currently a hack left in for a scheme wrapper library. +It may be removed. -By default, there are no such functions. +Don't use it. -@marshal_func: the function to invoke on every handlers for which there -isn't a function pointer. May be NULL. -@destroy_func: the function to invoke when each hook is destroyed. -May be NULL. +@object: The object which emits the signal. +@data: The user data associated with the hook. +@nparams: The number of parameters to the function. +@args: The actual values of the arguments. +@arg_types: The types of the arguments. +@return_type: The type of the return value from the function +or #GTK_TYPE_NONE for no return value. - + - +This structure contains all the information about a particular +signal: its name, the type it affects, the signature of the handlers, +and its unique identifying integer. -@buffer: -@time: +@object_type: +@signal_id: +@signal_name: +@is_user_signal: +@signal_flags: +@return_val: +@nparams: +@params: - + - +Holds the data for a statusbar message. text holds the actual text string. context_id is the context that this message is associated with, and message_id is this particular message's identifier. However, these fields should not be modified directly. -@buffer: -@time: -@interactive: -@default_editable: +@text: +@context_id: +@message_id: - + - +A #GtkJustification for the text. This is only used when the tag is +applied to the first character in a paragraph. -@buffer: -@regexp: -@start: -@end: -@Returns: - + - +Pixel width of the left margin of the text for lines after the first +line in a wrapped paragraph. -@buffer: -@iter: -@str: -@start: -@end: -@Returns: - + -@buffer: -@Returns: - + - +Pixels to offset the text horizontally or vertically, useful to +produce superscript and subscript. -@buffer: -@iter: -@Returns: - + -@buffer: -@iter: -@pixmap: -@mask: +@widget: the object which received the signal. +@area: - + -@buffer: -@override_location: -@time: -@interactive: -@default_editable: +@widget: the object which received the signal. - + -@buffer: -@text: +@widget: the object which received the signal. - + - +Initializes a previously allocated #GtkCList widget for use. This should not +normally be used to create a #GtkCList widget. Use gtk_clist_new() instead. -@buffer: +@clist: A pointer to an uninitialized #GtkCList widget. +@columns: The number of columns the #GtkCList should have. +@titles: An array of strings that should be used as the titles i +of the columns. There should be enough strings in the array for +the number of columns specified. - + - +Controls whether opacity can be set with the #GtkColorSelection. +If this functionality is enabled, the necessary additional widgets +are added to the #GtkColorSelection and the opacity value can be +retrieved via the fourth value in the color array returned by +the gtk_color_selection_get_color() function. -@iter: -@Returns: +@colorsel: a #GtkColorSelection. +@use_opacity: a boolean indicating whether the opacity selection +is enabled. - + - +This function is not usually used by users. -@iter: -@pixmap: -@mask: -@Returns: +@ctree: +@columns: +@tree_column: +@titles: - + - +Causes the "changed" signal to be emitted. -@iter: -@start: -@end: -@Returns: +@editable: a #GtkEditable widget. - + - +Claim or disclaim ownership of the PRIMARY X selection. -@iter: -@Returns: +@editable: a #GtkEditable widget. +@claim: if %TRUE, claim the selection, otherwise, disclaim it. +@time: the timestamp for claiming the selection. - + - +Sets one of the two font filters, to limit the fonts shown. -@iter: -@Returns: +@fsd: a #GtkFontSelectionDialog. +@filter_type: which of the two font filters to set, either +#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter +can be changed by the user, but the base filter is permanent. +@font_type: the types of font to be shown. This is a bitwise combination of +#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, +or #GTK_FONT_ALL to show all three font types. +@foundries: a NULL-terminated array of strings containing foundry names which +will be shown, or NULL to show all foundries. +@weights: a NULL-terminated array of strings containing weight names which +will be shown, or NULL to show all weights. +@slants: a NULL-terminated array of strings containing slant names which +will be shown, or NULL to show all slants. +@setwidths: a NULL-terminated array of strings containing setwidth names which +will be shown, or NULL to show all setwidths. +@spacings: a NULL-terminated array of strings containing spacings which +will be shown, or NULL to show all spacings. +@charsets: a NULL-terminated array of strings containing charset names which +will be shown, or NULL to show all charsets. - + - +Sets one of the two font filters, to limit the fonts shown. -@mark: -@Returns: +@fontsel: a #GtkFontSelection. +@filter_type: which of the two font filters to set, either +#GTK_FONT_FILTER_BASE or #GTK_FONT_FILTER_USER. The user filter +can be changed by the user, but the base filter is permanent. +@font_type: the types of font to be shown. This is a bitwise combination of +#GTK_FONT_BITMAP, #GTK_FONT_SCALABLE and #GTK_FONT_SCALABLE_BITMAP, +or #GTK_FONT_ALL to show all three font types. +@foundries: a NULL-terminated array of strings containing foundry names which +will be shown, or NULL to show all foundries. +@weights: a NULL-terminated array of strings containing weight names which +will be shown, or NULL to show all weights. +@slants: a NULL-terminated array of strings containing slant names which +will be shown, or NULL to show all slants. +@setwidths: a NULL-terminated array of strings containing setwidth names which +will be shown, or NULL to show all setwidths. +@spacings: a NULL-terminated array of strings containing spacings which +will be shown, or NULL to show all spacings. +@charsets: a NULL-terminated array of strings containing charset names which +will be shown, or NULL to show all charsets. - + - +Get the type of GtkIdentifier. -@mark: -@Returns: +@Returns: GtkType -- the enumerated type of something. - + - +Private function to get an argument and argument info from an object. -@mark: -@Returns: +@object: the object whose argument should be retrieved. +@arg: the argument, for the name on input, the rest is filled on output. +@info: a #GtkArgInfo structure to optionally fill in. - + - +Query information about an argument type. -@mark: +@object_type: type of object to query about. +@arg_name: name of the argument. +@info_p: pointer to be filled in with a pointer to the GtkArgInfo. +@Returns: an error message, or NULL on success. +It is the caller's responsibility to call g_free() in the event of error. - + - +Private function to set an argument and argument info to an object. -@text_view: -@iter: -@x: -@y: +@object: the object whose argument should be set. +@arg: the argument. +@info: infomation about this type of argument in general. - + - +Private: Gets an array of #GtkArgs from a va_list C structure. -@engine: -@Returns: +@object_type: the type of object to collect arguments for. +@arg_list_p: pointer to be filled in with a list of parsed arguments. +@info_list_p: optional pointer for a returned list #GtkArgInfos. +@first_arg_name: name of first argument. +@var_args: value of first argument, followed by more key/value pairs, +terminated by NULL. +@Returns: an error message, or NULL on success. +It is the caller's responsibility to call g_free() in the event of error. - + - +Add an array of signals to a #GtkObjectClass. +Usually this is called when registering a new type of object. -@name: -@Returns: +@klass: the object class to append signals to. +@signals: the signals to append. +@nsignals: the number of signals being appended. - + - +Define a signal-handler for a new signal on an already defined +object. + + +See the signal documentation for more general information. -@engine: +@klass: the object class to define the signal for. +@name: the name of the signal. +@signal_flags: the default emission behavior for the signal. +See gtk_signal_new(). +@marshaller: a function that will take an array of GtkArgs +and invoke the appropriate handler with the normal calling +conventions. +@return_val: specify the return-value type for the signal +(or GTK_TYPE_NONE for no return-value). +@nparams: specify the number of parameters the signal +receives from the caller of gtk_signal_emit(). +@Varargs: list of nparams #GtkTypes to pass to the signal handlers. +@Returns: the signal id. (See #GtkSignals) - + +Define a signal-handler for a new signal on an already defined +object. + + +@klass: the object class to define the signal for. +@name: the name of the signal. +@signal_flags: the default emission behavior for the signal. +See gtk_signal_new(). +@marshaller: takes a GtkObject, a #GtkSignalFunc, and an array +of arguments, and invokes the function using the appropriate +calling conventions. Usually just select a function +out of gtkmarshal.h. +@return_val: specify the return-value type for the signal (possibly +#GTK_TYPE_NONE). +@nparams: specify the number of parameters the signal +receives from the caller of gtk_signal_emit(). +@params: array of #GtkTypes the signal handlers for this signal +should have in their prototype (of length nparams). +@Returns: the signal id. (See #GtkSignals) + + +Mark an allocated object as constructed. +This is used for situations +that require precise control of the construction process. + + +This is done when gtk_object_default_construct() is inadequate. +In #GtkCList the need arises because #GtkCList does construction work that +must happen after its derivers. This work +cannot be done in an initializer function, so an alternate +constructor is mandatory. It calls gtk_object_constructed() to +indicate it has done its job, so that no other constructor will +be invoked. - -@engine: -@parent_type: -@type_name: -@type_info: -@Returns: - - - +Normally this function is just automatically run from +gtk_object_default_construct(). -@engine: +@object: object which has been constructed. This is usually +done automatically by gtk_object_new() and gtk_object_newv(). - + - +This function is called to construct arguments that haven't been initialized +but have the #GTK_ARG_CONSTRUCT flag set. - -@error_code: - - - +All number arguments are set to 0. All pointers and strings +are set to NULL. - -@argc: -@argv: - - -Private: print debugging information while doing a gtk_object_ref() or -a gtk_object_unref(). +Normally invoked by gtk_object_new() automatically; gtk_type_new() can +be used to bypass it. -@object: object to reference or unreference. -@func: name of caller's function to print (used within macros). -@dummy: unused. -@line: line number (used within macros). -@do_ref: whether to reference or unreference. +@object: the object to initialize. - + - +Gets an array of argument values from an object. -@tree_model_sort: +@object: the object to get arguments from. +@n_args: the number of arguments to query. +@args: the arguments to fill in. - + - +Construct an object with an array of arguments. -@tree_model_sort: -@sort_col: +@object_type: the type of the object to create. +@n_args: the number of arguments to set. +@args: an array of n_args arguments (which are name and value pairs). +@Returns: the new GtkObject. - + - +Get all the arguments that may be used for a given type. - -@Returns: - - - +In Java, this type of mechanism is called +introspection. It is used by applications +like Glade, that have to determine what can be done to an object +at run-time. -@tree_view: -@Returns: +@class_type: the GtkType of the ObjectClass +(returned from GTK_OBJECT_CLASS(class)->type for example). +@arg_flags: if non-NULL, obtains the #GtkArgFlags that apply to +each argument. You must g_free() this if you request it. +@n_args: the number of arguments is returned in this field. +@Returns: an array of arguments, that you must deallocate with g_free(). - + - +Set an array of arguments. -@selection: -@tree_view: +@object: the object whose arguments should be set. +@n_args: the number of arguments to set. +@args: the desired values, as an array of #GtkArgs (which contain +the names, types, and values of the arguments). - + - +Internal function used by #GtkHPaned and #GtkVPaned -@selection: -@type: +@paned: +@allocation: +@child1_req: +@child2_req: - + - +Internal function. -@tree_store: -@iter: - + -@tree_store: -@iter: -@var_args: +@ruler: the gtkruler - + -@n_columns: -@Varargs: -@Returns: +@ruler: the gtkruler - + - +Add an emission hook for a type of signal, for any object. +(with control of what happens when the hook is +destroyed). -@tree_store: -@iter: -@var_args: +@signal_id: the type of signal add the hook for. +@hook_func: the function to invoke to handle the hook. +@data: the user data passed in to hook_func. +@destroy: a function to invoke when the hook is destroyed, +to clean up any allocation done just for this +signal handler. +@Returns: the id (that you may pass as a parameter +to gtk_signal_remove_emission_hook()). - + - +Returns whether a connection id is valid (and optionally not blocked). -@tree_column: -@Returns: +@object: the object to search for the desired handler. +@handler_id: the connection id. +@may_be_blocked: whether it is acceptable to return a blocked +handler. +@Returns: TRUE if the signal exists and wasn't blocked, +unless #may_be_blocked was specified. FALSE otherwise. - + - +Destroy all the signal handlers connected to an object. +This is done automatically when the object is destroyed. - -@tree_column: -@Returns: - - - +This function is labeled private. -@tree_column: -@Returns: +@object: the object whose signal handlers should be destroyed. - + -@tree_column: -@Returns: - + - +Find out the recursion depth of emissions for a particular type +of signal and object. (So it will +always return 0 or 1 if #GTK_RUN_NO_RECURSE is specified) +This is a way to avoid recursion: you can see if +you are currently running in that signal handler and emit it only +if you are. - -@tree_column: -@type: - - - - +Another way to look at it is that this number increases +by one when #gtk_signal_emit(), et al, are called, +and decreases by one when #gtk_signal_emit() returns. -@tree_column: -@active: +@object: the object with the signal handler. +@signal_id: the signal id. +@Returns: the recursion depth of emissions of this signal for this +object. - + - +Find out the recursion depth of emissions for a particular type +of signal and object. Just like gtk_signal_n_emissions() +except it will lookup the signal id for you. -@tree_column: -@active: +@object: the object with the signal handler. +@name: the signal name. +@Returns: the recursion depth of emissions of this signal for this +object. - + - +Obtain information about a signal. -@tree_column: -@justification: +@signal_id: the signal type identifier. +@Returns: a pointer to a GtkSignalQuery structure +which contains all the information, or NULL. +The pointer is allocated just for you: you must g_free() it. - + - +These set default functions to call when the user didn't +supply a function when connecting. (These are rarely +used, and probably only for language bindings) - -@tree_column: -@size: -@width: - - - +By default, there are no such functions. -@tree_view: -@path: -@column: -@row_align: -@col_align: +@marshal_func: the function to invoke on every handlers for which there +isn't a function pointer. May be NULL. +@destroy_func: the function to invoke when each hook is destroyed. +May be NULL. - + - +Private: print debugging information while doing a gtk_object_ref() or +a gtk_object_unref(). -@tree_view: -@active: +@object: object to reference or unreference. +@func: name of caller's function to print (used within macros). +@dummy: unused. +@line: line number (used within macros). +@do_ref: whether to reference or unreference. @@ -5009,115 +1142,3 @@ Set the varargs type for a fundamental type @foreign_type. fundamental type. @varargs_type: Must be a GtkType which is either structured or flag, or NONE. - - - - - -@widget: -@arg: - - - - - - -@widget: -@nargs: -@args: - - - - - - -@type: -@nargs: -@args: -@Returns: - - - - - - -@v: - - - - - - -@v: -@visual: - - - - - - -@widget: -@stock_id: -@size: -@detail: -@Returns: - - - - - - -@v: -@visual: - - - - - - -@w: -@v: -@widget: -@visual: - - - - - - -@widget: -@nargs: -@args: - - - - - - -@window: -@xid: - - - - - - -@window: -@xid: - - - - - - -@window: -@defaultw: - - - - - - -@window: -@focus: - diff --git a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml index cafd4fb01e..fc0aa6075b 100644 --- a/docs/reference/gtk/tmpl/gtkcellrenderer.sgml +++ b/docs/reference/gtk/tmpl/gtkcellrenderer.sgml @@ -22,6 +22,7 @@ GtkCellRenderer @GTK_CELL_RENDERER_SELECTED: @GTK_CELL_RENDERER_PRELIT: @GTK_CELL_RENDERER_INSENSITIVE: +@GTK_CELL_RENDERER_SORTED: diff --git a/docs/reference/gtk/tmpl/gtkcombo.sgml b/docs/reference/gtk/tmpl/gtkcombo.sgml index 7113bbe6e4..0e115ea39c 100644 --- a/docs/reference/gtk/tmpl/gtkcombo.sgml +++ b/docs/reference/gtk/tmpl/gtkcombo.sgml @@ -202,3 +202,18 @@ instead. @combo: a #GtkCombo. + + + + + + + + + + + + + + + diff --git a/docs/reference/gtk/tmpl/gtkentry.sgml b/docs/reference/gtk/tmpl/gtkentry.sgml index 7e5111e1db..f5d0720a0e 100644 --- a/docs/reference/gtk/tmpl/gtkentry.sgml +++ b/docs/reference/gtk/tmpl/gtkentry.sgml @@ -295,3 +295,8 @@ are visible or not. See gtk_entry_set_visibility(). + + + + + diff --git a/docs/reference/gtk/tmpl/gtkenums.sgml b/docs/reference/gtk/tmpl/gtkenums.sgml index 162f9300ba..00419b966b 100644 --- a/docs/reference/gtk/tmpl/gtkenums.sgml +++ b/docs/reference/gtk/tmpl/gtkenums.sgml @@ -253,6 +253,14 @@ contains grayscale or red-green-blue data. @GTK_SCROLL_PAGE_BACKWARD: @GTK_SCROLL_PAGE_FORWARD: @GTK_SCROLL_JUMP: +@GTK_SCROLL_STEP_UP: +@GTK_SCROLL_STEP_DOWN: +@GTK_SCROLL_PAGE_UP: +@GTK_SCROLL_PAGE_DOWN: +@GTK_SCROLL_STEP_LEFT: +@GTK_SCROLL_STEP_RIGHT: +@GTK_SCROLL_PAGE_LEFT: +@GTK_SCROLL_PAGE_RIGHT: diff --git a/docs/reference/gtk/tmpl/gtkrange.sgml b/docs/reference/gtk/tmpl/gtkrange.sgml index 4445609d53..46e45cb64d 100644 --- a/docs/reference/gtk/tmpl/gtkrange.sgml +++ b/docs/reference/gtk/tmpl/gtkrange.sgml @@ -47,134 +47,6 @@ GtkRange @adjustment: - - - - - -@range: - - - - - - - -@range: - - - - - - - -@range: - - - - - - - -@range: - - - - - - - -@range: - - - - - - - -@range: - - - - - - - -@range: -@x: -@y: -@jump_perc: -@Returns: - - - - - - - -@range: - - - - - - - -@range: - - - - - - - -@range: -@x: -@y: -@jump_perc: -@Returns: - - - - - - - -@range: -@x: -@y: -@jump_perc: -@Returns: - - - - - - - -@range: -@xdelta: -@ydelta: - - - - - - - -@range: -@xdelta: -@ydelta: - - - - - - - -@range: - - diff --git a/docs/reference/gtk/tmpl/gtksignal.sgml b/docs/reference/gtk/tmpl/gtksignal.sgml index 992da38806..c3696cb03c 100644 --- a/docs/reference/gtk/tmpl/gtksignal.sgml +++ b/docs/reference/gtk/tmpl/gtksignal.sgml @@ -244,13 +244,6 @@ to the signal. @GTK_RUN_ACTION: @GTK_RUN_NO_HOOKS: - - - - - - - Create a new signal type. (This is usually done in the diff --git a/docs/reference/gtk/tmpl/gtktextbuffer.sgml b/docs/reference/gtk/tmpl/gtktextbuffer.sgml index 980fb9c0fa..c9db052622 100644 --- a/docs/reference/gtk/tmpl/gtktextbuffer.sgml +++ b/docs/reference/gtk/tmpl/gtktextbuffer.sgml @@ -455,15 +455,6 @@ types related to the text widget and how they work together. @anchor: - - - - - -@buffer: -@iter: - - @@ -474,15 +465,6 @@ types related to the text widget and how they work together. @end: - - - - - -@buffer: -@Returns: - - @@ -609,6 +591,15 @@ types related to the text widget and how they work together. @textbuffer: the object which received the signal. + + + + + +@textbuffer: the object which received the signal. +@arg1: +@arg2: + diff --git a/docs/reference/gtk/tmpl/gtktextiter.sgml b/docs/reference/gtk/tmpl/gtktextiter.sgml index 522ea9fdab..faf5a099e7 100644 --- a/docs/reference/gtk/tmpl/gtktextiter.sgml +++ b/docs/reference/gtk/tmpl/gtktextiter.sgml @@ -349,15 +349,6 @@ types related to the text widget and how they work together. @Returns: - - - - - -@iter: -@Returns: - - diff --git a/docs/reference/gtk/tmpl/gtktexttag.sgml b/docs/reference/gtk/tmpl/gtktexttag.sgml index 939af5d93b..a138f63333 100644 --- a/docs/reference/gtk/tmpl/gtktexttag.sgml +++ b/docs/reference/gtk/tmpl/gtktexttag.sgml @@ -407,11 +407,6 @@ applies to the first character in a paragraph. - - - - - @@ -422,11 +417,6 @@ applies to the first character in a paragraph. - - - - - diff --git a/docs/reference/gtk/tmpl/gtktreemodelsimple.sgml b/docs/reference/gtk/tmpl/gtktreemodelsimple.sgml index a3ae2da106..5b11ca658c 100644 --- a/docs/reference/gtk/tmpl/gtktreemodelsimple.sgml +++ b/docs/reference/gtk/tmpl/gtktreemodelsimple.sgml @@ -14,59 +14,3 @@ GtkModelSimple - - - - - -@parent: -@stamp: - - - - - - -@Returns: - - - - - - - -@simple: -@path: -@iter: - - - - - - - -@simple: -@path: -@iter: - - - - - - - -@simple: -@path: -@iter: - - - - - - - -@simple: -@path: -@iter: - - diff --git a/docs/reference/gtk/tmpl/gtktreeselection.sgml b/docs/reference/gtk/tmpl/gtktreeselection.sgml index eb6d2695c2..9998d0055e 100644 --- a/docs/reference/gtk/tmpl/gtktreeselection.sgml +++ b/docs/reference/gtk/tmpl/gtktreeselection.sgml @@ -61,6 +61,7 @@ GtkTreeSelection @selection: @func: @data: +@destroy: diff --git a/docs/reference/gtk/tmpl/gtktreestore.sgml b/docs/reference/gtk/tmpl/gtktreestore.sgml index 03d90183ac..541fab7d83 100644 --- a/docs/reference/gtk/tmpl/gtktreestore.sgml +++ b/docs/reference/gtk/tmpl/gtktreestore.sgml @@ -84,16 +84,6 @@ GtkTreeStore @Varargs: - - - - - -@tree_store: -@iter: -@Varargs: - - diff --git a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml index 15a4ee127d..d813c35ada 100644 --- a/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml +++ b/docs/reference/gtk/tmpl/gtktreeviewcolumn.sgml @@ -38,8 +38,10 @@ GtkTreeViewColumn @width: @min_width: @max_width: +@displayed_width: @func: @func_data: +@destroy: @title: @cell: @attributes: @@ -59,18 +61,6 @@ GtkTreeViewColumn @GTK_TREE_VIEW_COLUMN_AUTOSIZE: @GTK_TREE_VIEW_COLUMN_FIXED: - - - - - -@tree_column: -@tree_model: -@iter: -@data: -@Returns: - - @@ -227,6 +217,15 @@ GtkTreeViewColumn @title: + + + + + +@tree_column: +@Returns: + + diff --git a/docs/reference/gtk/tmpl/gtktypeutils.sgml b/docs/reference/gtk/tmpl/gtktypeutils.sgml index fb9ebab55d..09743cfddf 100644 --- a/docs/reference/gtk/tmpl/gtktypeutils.sgml +++ b/docs/reference/gtk/tmpl/gtktypeutils.sgml @@ -546,6 +546,7 @@ nickname. Initialize the data structures associated with gtk types. +@debug_flags: diff --git a/docs/reference/gtk/tmpl/gtkwidget.sgml b/docs/reference/gtk/tmpl/gtkwidget.sgml index 9180b2ede4..b0fb70150f 100644 --- a/docs/reference/gtk/tmpl/gtkwidget.sgml +++ b/docs/reference/gtk/tmpl/gtkwidget.sgml @@ -468,22 +468,6 @@ GtkWidget @area: - - - - - -@widget: - - - - - - - -@widget: - - @@ -1426,20 +1410,6 @@ GtkWidget @time: @Returns: - - - - - -@widget: the object which received the signal. - - - - - - -@widget: the object which received the signal. - @@ -1738,6 +1708,15 @@ GtkWidget @event: @Returns: + + + + + +@widget: the object which received the signal. +@event: +@Returns: + -- 2.30.2